Class EventManager

The events API service manager.

Hierarchy

EventManager

Implements

Event.IManager

Index

Constructors

Properties

_poll _socket _stream _subscribe serverSettings

Accessors

isDisposed stream

Methods

Constructors

constructor

new EventManager(options?): EventManager
Create a new event manager.
Parameters
- Optional options: EventManager.IOptions
Returns EventManager
- Defined in packages/services/lib/event/index.d.ts:12

Properties

`Private` _poll

_poll: any

`Private` _socket

_socket: any

`Private` _stream

_stream: any

`Private` _subscribe

_subscribe: any

Subscribe to event bus emissions.

`Readonly` serverSettings

serverSettings: ServerConnection.ISettings

The server settings used to make API requests.

Accessors

isDisposed

get isDisposed(): boolean
Whether the event manager is disposed.

Returns boolean
Implementation of IManager.isDisposed
- Defined in packages/services/lib/event/index.d.ts:20

stream

get stream(): Stream
An event stream that emits and yields each new event.

Returns Stream
Implementation of IManager.stream
- Defined in packages/services/lib/event/index.d.ts:24

Methods

dispose

dispose(): void
Dispose the event manager.

Returns void
Implementation of IManager.dispose
- Defined in packages/services/lib/event/index.d.ts:28

emit

emit(event): Promise<void>
Post an event request to be emitted by the event bus.
Parameters
- event: Event.Request
Returns Promise<void>
Implementation of IManager.emit
- Defined in packages/services/lib/event/index.d.ts:32

Generated using TypeDoc