Functions: createEmitter()
ts
function createEmitter<TEvents>(options?): objectType Parameters
| Type Parameter |
|---|
TEvents extends EmitterEvents |
Parameters
| Parameter | Type |
|---|---|
options? | EmitterOptions |
Returns
object
clear()
ts
clear: () => void;Returns
void
count()
ts
count: <E>() => number<E>(event, options?) => number;Type Parameters
| Type Parameter |
|---|
E extends string | number | symbol |
Returns
number
Type Parameters
| Type Parameter |
|---|
E extends string | number | symbol |
Parameters
| Parameter | Type |
|---|---|
event | E |
options? | { global: boolean; } |
options.global? | boolean |
Returns
number
emit()
ts
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()
ts
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()
ts
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()
ts
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()
ts
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()
ts
setOptions: (options) => void;Parameters
| Parameter | Type |
|---|---|
options | EmitterOptions |
Returns
void