EventEmitter
Import
import { EventEmitter } from "@hyper-fetch/core"
Source
Package
Parameters
class EventEmitter {
constructor(options: EventEmitterOptions) {};
defaultMaxListeners: number;
emitCallbacks: (event: string, data: any, isTriggeredExternally?: true) => void[];
addListener() => (event: string | symbol, listener: (...args: any[]) => void) => EventEmitter;
removeListener() => (event: string | symbol, listener: (...args: any[]) => void) => EventEmitter;
emit(type: string, data: any, isTriggeredExternally: boolean) => boolean;
eventNames() => (string | symbol)[];
getMaxListeners() => number;
listenerCount(event: string | symbol, listener?: Function) => number;
listeners(event: string | symbol) => Function[];
off(event: string | symbol, listener: (...args: any[]) => void) => EventEmitter;
on(event: string | symbol, listener: (...args: any[]) => void) => EventEmitter;
onEmit(callback: (event: string, data: any, isTriggeredExternally?: true) => void) => () => void;
onListener(event: string, listener: (count: number) => void) => () => void;
once(event: string | symbol, listener: (...args: any[]) => void) => this;
prependListener(event: string | symbol, listener: (...args: any[]) => void) => this;
prependOnceListener(event: string | symbol, listener: (...args: any[]) => void) => this;
rawListeners(event: string | symbol) => Function[];
removeAllListeners(event?: string | symbol) => this;
setMaxListeners(n: number) => this;
listenerCount(emitter: EventEmitter, event: string | symbol) => number;
}
Parameters
| Name | Type | Description |
|---|---|---|
| options | |
Properties
Methods
emit()
Overrides Emitter.emit
Source
Preview
emit(type: string, data: any, isTriggeredExternally: boolean)
Parameters
Parameters
| Name | Type | Description |
|---|---|---|
| type | | |
| data | | |
| isTriggeredExternally | |
Returns
boolean
listenerCount()
Inherited from Emitter.listenerCount
Source
Preview
listenerCount(event: string | symbol, listener: Function)
Parameters
Parameters
| Name | Type | Description |
|---|---|---|
| event | | |
| listener | |
Returns
number
listeners()
Inherited from Emitter.listeners
Source
Preview
listeners(event: string | symbol)
Parameters
Parameters
| Name | Type | Description |
|---|---|---|
| event | |
Returns
Function[]
off()
Overrides Emitter.off
Source
Preview
off(event: string | symbol, listener: (...args: any[]) => void)
Parameters
Parameters
| Name | Type | Description |
|---|---|---|
| event | | |
| listener | |
Returns
EventEmitter
on()
Overrides Emitter.on
Source
Preview
on(event: string | symbol, listener: (...args: any[]) => void)
Parameters
Parameters
| Name | Type | Description |
|---|---|---|
| event | | |
| listener | |
Returns
EventEmitter
onEmit()
Source
Preview
onEmit(callback: (event: string, data: any, isTriggeredExternally?: true) => void)
Parameters
Parameters
| Name | Type | Description |
|---|---|---|
| callback | |
Returns
() => void
onListener()
Source
Preview
onListener(event: string, listener: (count: number) => void)
Parameters
Parameters
| Name | Type | Description |
|---|---|---|
| event | | |
| listener | |
Returns
() => void
once()
Inherited from Emitter.once
Source
Preview
once(event: string | symbol, listener: (...args: any[]) => void)
Parameters
Parameters
| Name | Type | Description |
|---|---|---|
| event | | |
| listener | |
Returns
this
prependListener()
Inherited from Emitter.prependListener
Source
Preview
prependListener(event: string | symbol, listener: (...args: any[]) => void)
Parameters
Parameters
| Name | Type | Description |
|---|---|---|
| event | | |
| listener | |
Returns
this
prependOnceListener()
Inherited from Emitter.prependOnceListener
Source
Preview
prependOnceListener(event: string | symbol, listener: (...args: any[]) => void)
Parameters
Parameters
| Name | Type | Description |
|---|---|---|
| event | | |
| listener | |
Returns
this
rawListeners()
Inherited from Emitter.rawListeners
Source
Preview
rawListeners(event: string | symbol)
Parameters
Parameters
| Name | Type | Description |
|---|---|---|
| event | |
Returns
Function[]
removeAllListeners()
Inherited from Emitter.removeAllListeners
Source
Preview
removeAllListeners(event: string | symbol)
Parameters
Parameters
| Name | Type | Description |
|---|---|---|
| event | |
Returns
this
setMaxListeners()
Inherited from Emitter.setMaxListeners
Source
Preview
setMaxListeners(n: number)
Parameters
Parameters
| Name | Type | Description |
|---|---|---|
| n | |
Returns
this
listenerCount()
Inherited from Emitter.listenerCount
Source
Preview
listenerCount(emitter: EventEmitter, event: string | symbol)
Parameters
Parameters
| Name | Type | Description |
|---|---|---|
| emitter | | |
| event | |
Returns
number
