class DummyService extends Service {

  constructor(instanceName, dummyArgs) {
    super(`The ${instanceName}`);
    this.args = dummyArgs
    this.on('activate', this.#onActivate)
      .on('deactivate', this.#onDeactivate);
  }

  #onActivate = (event) => {
    // do activate stuff with this.args ...
  }

  #onDeactivate = (event) => {
    // do deactivate stuff with this.args ...
  }

}

// else where ...
function dummyEventCallback(event, svc) {
  console.info(`${svc.name}` was ${event}`);
}

const service = new DummyService('Bob', bobInfo)
  .on('activated', dummyEventCallback)
  .on('deactivated', dummyEventCallback);
service.activate();
service.deactivate();

Members

logger :module:base.Logger

lib/base.js, line 2573

name :string

lib/base.js, line 2578

shortName :string

lib/base.js, line 2583

inner, constant eventTypes :Array.<module:base.Dispatcher~EventType>

lib/base.js, line 2661

Service events.

Methods

activate()

lib/base.js, line 2593

Called each time service is activated.

Fires:

• module:base.Service#event:activate
• module:base.Service#event:activated

allowReactivation(allow) → {module:base.Service}

lib/base.js, line 2645

Parameters:

Name	Type	Description
allow	boolean	Whether to allow this service to be activated when already active.

Returns:

module:base.Service -

This instance, for chaining.

deactivate()

lib/base.js, line 2607

Called each time service is deactivated.

Fires:

• module:base.Service#event:deactivate
• module:base.Service#event:deactivated

off(eventType, func) → {module:base.Service}

lib/base.js, line 2635

Remove all instances of a function registered to an eventType.

Parameters:

Name	Type	Description
eventType	module:base.Dispatcher~EventType	Event type to disconnect from.
func	module:base.Dispatcher~Handler	Function to remove.

Returns:

module:base.Service -

This instance, for chaining.

on(eventType, func) → {module:base.Service}

lib/base.js, line 2622

Attach a function to an eventType.

Parameters:

Name	Type	Description
eventType	module:base.Dispatcher~EventType	Event type to connect with.
func	module:base.Dispatcher~Handler	Single argument function to call.

Returns:

module:base.Service -

This instance, for chaining.

setShortName(shortName) → {module:base.Service}

lib/base.js, line 2654

Parameters:

Name	Type	Description
shortName	string	Custom name portion of this instance.

Returns:

module:base.Service -

This instance, for chaining.

Events

activate

lib/base.js, line 2668

activated

lib/base.js, line 2671

deactivate

lib/base.js, line 2674

deactivated

lib/base.js, line 2677