History

Daniel Lockyer 48fd5ca8cb Removed posttest linting step - linting is done as a separate step in CI and it's a git hook upon pushing locally, so we don't need to run it after tests		2022-07-21 10:09:36 +02:00
..
lib
test
.eslintrc.js
index.js
jsconfig.json
LICENSE
package.json	Removed posttest linting step	2022-07-21 10:09:36 +02: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