@eq8/core

EQuateJS Core API Library - A loose interface for CQRS/ES

NOTE: The package eq8-core can be found in the legacy branch.

Overview

The core building blocks are:

• commands in the form of events for updating the application state; and,
• queries are used for returning the current state of the application.

Contents

• Installation
• Events
  • Event: 'dispatch'
  • Event: 'subscribe'
• Constructor
  • Parameters
• Methods
  • Core#dispatch(e, done)
    • Parameters
  • Core#subscribe(q, done)
    • Parameters
• Appendices

Installation

npm install --save @eq8/core

Events

Basically, @eq8/core is an EventEmitter object and has the following events:

Event: 'dispatch'

Emitted when Core#dispatch gets called

Event: 'subscribe'

Emitted when Core#subscribe gets called

Constructor

var core = require('@eq8/core')(options);

Parameters

• options is an optional object with the following attributes:
  • logger by default is winston object

Methods

Core#dispatch(e, done)

Emits a dispatch event and passes the parameters e and done to the event handler

Parameters

• e is an arbitrary object to represent a command event

Core#subscribe(q, done)

Emits a subscribe event and passes the parameters q and done to the event handler

Parameters

• q is an arbitrary object to represent a query event
• done is an arbitrary callback function but conventionally takes an error-first argument: var done = function(err, ...){ ...}

Appendices

• [Contributing] (./CONTRIBUTING.md)
• [License] (./LICENSE)