Interface IPathEventEmitter

interface IPathEventEmitter {
    emit(event: string, ...args: any[]): void;
    off(listener: PathListener): void;
    on(event: string, listener: PathListener): PathUnsubscribe;
    once(event: string, listener?: PathListener): Promise<any>;
    relayEvents(emitter: PathEventEmitter): void;
}

Implemented by

PathEventEmitter

Index

Methods

emit off on once relayEvents

Methods

emit

emit(event, ...args): void
Parameters
- event: string
- Rest...args: any[]
Returns void
- Defined in src/path-events.ts:238

off

off(listener): void
Parameters
- listener: PathListener
Returns void
- Defined in src/path-events.ts:239

on

on(event, listener): PathUnsubscribe
Parameters
- event: string
- listener: PathListener
Returns PathUnsubscribe
- Defined in src/path-events.ts:240

once

once(event, listener?): Promise<any>
Parameters
- event: string
- Optionallistener: PathListener
Returns Promise<any>
- Defined in src/path-events.ts:241

relayEvents

relayEvents(emitter): void
Parameters
- emitter: PathEventEmitter
Returns void
- Defined in src/path-events.ts:242