Functions: createEmitter()

function createEmitter<TEvents>(options?): object

Type Parameters

Type Parameter
TEvents extends EmitterEvents

Parameters

Parameter	Type
options?	EmitterOptions

Returns

object

clear()

clear: () => void;

Returns

void

emit()

emit: <E>(event) => void<E>(event, payload) => void;

Type Parameters

Type Parameter
E extends string | number | symbol

Parameters

Parameter	Type
event	undefined extends EventPayload<TEvents, E> ? E : never

Returns

void

Type Parameters

Type Parameter
E extends string | number | symbol

Parameters

Parameter	Type
event	E
payload	EventPayload<TEvents, E>

Returns

void

next()

next: (options?) => Promise<GlobalEventHandlerResponse<TEvents>><E>(event, options?) => Promise<EventPayload<TEvents, E>>;

Parameters

Parameter	Type
options?	EmitterNextOptions

Returns

Promise<GlobalEventHandlerResponse<TEvents>>

Type Parameters

Type Parameter
E extends string | number | symbol

Parameters

Parameter	Type
event	E
options?	EmitterNextOptions

Returns

Promise<EventPayload<TEvents, E>>

off()

off: (globalEventHandler) => void<E>(event) => void<E>(event, handler) => void;

Parameters

Parameter	Type
globalEventHandler	GlobalEventHandler<TEvents>

Returns

void

Type Parameters

Type Parameter
E extends string | number | symbol

Parameters

Parameter	Type
event	E

Returns

void

Type Parameters

Type Parameter
E extends string | number | symbol

Parameters

Parameter	Type
event	E
handler	EventHandler<EventPayload<TEvents, E>>

Returns

void

on()

on: (globalEventHandler, options?) => () => void<E>(event, handler, options?) => () => void;

Parameters

Parameter	Type
globalEventHandler	GlobalEventHandler<TEvents>
options?	EmitterOnOptions

Returns

Function

Returns

void

Type Parameters

Type Parameter
E extends string | number | symbol

Parameters

Parameter	Type
event	E
handler	EventHandler<EventPayload<TEvents, E>>
options?	EmitterOnOptions

Returns

Function

Returns

void

once()

once: (globalEventHandler, options?) => () => void<E>(event, handler, options?) => () => void;

Parameters

Parameter	Type
globalEventHandler	GlobalEventHandler<TEvents>
options?	EmitterOnceOptions

Returns

Function

Returns

void

Type Parameters

Type Parameter
E extends string | number | symbol

Parameters

Parameter	Type
event	E
handler	EventHandler<EventPayload<TEvents, E>>
options?	EmitterOnceOptions

Returns

Function

Returns

void

setOptions()

setOptions: (options) => void;

Parameters

Parameter	Type
options	EmitterOptions

Returns

void