IService | mage

IService interface

IService is an interface describing the service instance returned by mage.core.serviceDiscovery.createService

For some examples of how you can use this API, see https://mage.github.io/mage/api.html#examples

export
interface: IService

Hierarchy

IService

Index

Methods

Methods

announce

announce(port: number, metadata: any, callback: function): void

- Defined in mage.ts:2261
Announce the service as a new available service instance

memberof

IService

Parameters
- port: number
- metadata: any
- callback: function
  - - (error?: Error): void
    - Parameters
      - Optional error: Error
      Returns void
Returns void

discover

discover(): void

- Defined in mage.ts:2268
Start listening for the presence of service instances

memberof

IService

Returns void

on

on(eventName: ServiceEventName, handler: ServiceEventHandler | ServiceErrorEventHandler): void

- Defined in mage.ts:2277
Event listener

memberof

IService

Parameters
- eventName: ServiceEventName
- handler: ServiceEventHandler | ServiceErrorEventHandler
Returns void

once

once(eventName: ServiceEventName, handler: ServiceEventHandler | ServiceErrorEventHandler): void

- Defined in mage.ts:2286
Event listener

memberof

IService

Parameters
- eventName: ServiceEventName
- handler: ServiceEventHandler | ServiceErrorEventHandler
Returns void

removeAllListeners

removeAllListeners(eventName: ServiceEventName): void

- Defined in mage.ts:2295
Remove all instances of an event listener

memberof

IService

Parameters
- eventName: ServiceEventName
Returns void

removeListener

removeListener(eventName: ServiceEventName, handler: ServiceEventHandler | ServiceErrorEventHandler): void

- Defined in mage.ts:2304
Remove an instance of an event listener

memberof

IService

Parameters
- eventName: ServiceEventName
- handler: ServiceEventHandler | ServiceErrorEventHandler
Returns void