Interface IManager

The interface for the event bus front-end.

interface IManager {
    isDisposed: boolean;
    serverSettings: ServerConnection.ISettings;
    stream: Stream;
    dispose(): void;
    emit(event: Event.Request): Promise<void>;
}

Hierarchy

IDisposable
- IManager

Implemented by

EventManager

Index

Properties

isDisposed serverSettings stream

Methods

Properties

`Readonly`isDisposed

isDisposed: boolean

Test whether the object has been disposed.

Notes

This property is always safe to access.

`Readonly`serverSettings

serverSettings: ServerConnection.ISettings

The server settings used to make API requests.

`Readonly`stream

stream: Stream

An event stream that emits and yields each new event.

Methods

dispose

dispose(): void
Dispose of the resources held by the object.

Notes
If the object's dispose method is called more than once, all calls made after the first will be a no-op.

Undefined Behavior
It is undefined behavior to use any functionality of the object after it has been disposed unless otherwise explicitly noted.

Returns void
Inherited from IDisposable.dispose
- Defined in node_modules/@lumino/disposable/types/index.d.ts:28

emit

emit(event: Event.Request): Promise<void>
Post an event request to be emitted by the event bus.
Parameters
- event: Event.Request
Returns Promise<void>
- Defined in packages/services/src/event/index.ts:187