1. Home
  2. Classes
  3. NexusHoratio.base.Service

new Service( shortName )

Description

Base class for building services that can be turned on and off.

Subclasses should NOT override methods here, except for the constructor. Instead they should register listeners for appropriate events.

Parameters
Name Type Description
shortName string

Custom name portion of this instance.
Examples
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();
Details

lib/base.js, line 2578

Members

logger :NexusHoratio.base.Logger

Details
NexusHoratio.base.Logger

lib/base.js, line 2589

name :string

Details
string

lib/base.js, line 2594

shortName :string

Details
string

lib/base.js, line 2599

Methods

activate()

Description

Called each time service is activated.

Fires
Details

lib/base.js, line 2609

deactivate()

Description

Called each time service is deactivated.

Fires
Details

lib/base.js, line 2623

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

Description

Attach a function to an eventType.

Parameters
Name Type Description
eventType NexusHoratio.base.Dispatcher~EventType

Event type to connect with.
func NexusHoratio.base.Dispatcher~Handler

Single argument function to call.
Returns

This instance, for chaining.

Details

lib/base.js, line 2638

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

Description

Remove all instances of a function registered to an eventType.

Parameters
Name Type Description
eventType NexusHoratio.base.Dispatcher~EventType

Event type to disconnect from.
func NexusHoratio.base.Dispatcher~Handler

Function to remove.
Returns

This instance, for chaining.

Details

lib/base.js, line 2652

allowReactivation( allow ) → {NexusHoratio.base.Service}

Parameters
Name Type Description
allow boolean

Whether to allow this service to be activated when already active.
Returns

This instance, for chaining.

Details

lib/base.js, line 2662

setShortName( shortName ) → {NexusHoratio.base.Service}

Parameters
Name Type Description
shortName string

Custom name portion of this instance.
Returns

This instance, for chaining.

Details

lib/base.js, line 2671

Events

activate

Details

lib/base.js, line 2685

activated

Details

lib/base.js, line 2688

deactivate

Details

lib/base.js, line 2691

deactivated

Details

lib/base.js, line 2694