History

Daniel Lockyer db696a9272 Added `--all` to c8 command refs https://github.com/TryGhost/Toolbox/issues/203 - without `--all`, c8 ignores files that should be included in the coverage score but aren't used in tests - this means we have artificially high scores in places where this isn't used - this commit adds `--all` where previously missing - where this fails `--check-coverage`, that has been removed for now		2022-02-21 13:08:55 +01:00
..
lib	Added @tryghost/domain-events package	2021-09-17 15:22:08 +02:00
test	Added @tryghost/domain-events package	2021-09-17 15:22:08 +02:00
.eslintrc.js	Removed @babel/eslint-parser, set ecmaVersion instead	2022-02-15 12:30:17 +00:00
index.js	Added @tryghost/domain-events package	2021-09-17 15:22:08 +02:00
jsconfig.json	Added @tryghost/domain-events package	2021-09-17 15:22:08 +02:00
LICENSE	2022	2022-01-06 10:09:25 +00:00
package.json	Added `--all` to c8 command	2022-02-21 13:08:55 +01:00
README.md	Added @tryghost/domain-events package	2021-09-17 15:22:08 +02:00

README.md

Domain Events

Install

npm install @tryghost/domain-events --save

yarn add @tryghost/domain-events

Usage

const DomainEvents = require('@tryghost/domain-events');

class MyEvent {
    constructor(message) {
        this.timestamp = new Date();
        this.data = {
            message
        };
    }
}

DomainEvents.subscribe(MyEvent, function handler(event) {
    console.log(event.data.message);
});

const event = new MyEvent('hello world');

DomainEvents.dispatch(event);

Develop

This is a mono repository, managed with lerna.

Follow the instructions for the top-level repo.

git clone this repo & cd into it as usual
Run yarn to install top-level dependencies.

Run

yarn dev

Test

yarn lint run just eslint
yarn test run lint and tests