Skip to main content
Version: v8.0.0

EventEmitter


Import
import { EventEmitter } from "@hyper-fetch/core"

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
NameTypeDescription
options
EventEmitterOptions

Properties​

emitCallbacks​

Type
(event: string, data: any, isTriggeredExternally?: true) => void[]

defaultMaxListeners​

Inherited from Emitter.defaultMaxListeners
Type
number

Methods​

emit()​

Overrides Emitter.emit
Preview
emit(type: string, data: any, isTriggeredExternally: boolean)
Parameters
Parameters
NameTypeDescription
type
string
data
any
isTriggeredExternally
boolean
Returns
boolean

eventNames()​

Inherited from Emitter.eventNames
Preview
eventNames()
Returns
(string | symbol)[]

getMaxListeners()​

Inherited from Emitter.getMaxListeners
Preview
getMaxListeners()
Returns
number

listenerCount()​

Inherited from Emitter.listenerCount
Preview
listenerCount(event: string | symbol, listener: Function)
Parameters
Parameters
NameTypeDescription
event
string | symbol
listener
Function
Returns
number

listeners()​

Inherited from Emitter.listeners
Preview
listeners(event: string | symbol)
Parameters
Parameters
NameTypeDescription
event
string | symbol
Returns
Function[]

off()​

Overrides Emitter.off
Preview
off(event: string | symbol, listener: (...args: any[]) => void)
Parameters
Parameters
NameTypeDescription
event
string | symbol
listener
(...args: any[]) => void
Returns
EventEmitter

on()​

Overrides Emitter.on
Preview
on(event: string | symbol, listener: (...args: any[]) => void)
Parameters
Parameters
NameTypeDescription
event
string | symbol
listener
(...args: any[]) => void
Returns
EventEmitter

onEmit()​

Preview
onEmit(callback: (event: string, data: any, isTriggeredExternally?: true) => void)
Parameters
Parameters
NameTypeDescription
callback
(event: string, data: any, isTriggeredExternally?: true) => void
Returns
() => void

onListener()​

Preview
onListener(event: string, listener: (count: number) => void)
Parameters
Parameters
NameTypeDescription
event
string
listener
(count: number) => void
Returns
() => void

once()​

Inherited from Emitter.once
Preview
once(event: string | symbol, listener: (...args: any[]) => void)
Parameters
Parameters
NameTypeDescription
event
string | symbol
listener
(...args: any[]) => void
Returns
this

prependListener()​

Inherited from Emitter.prependListener
Preview
prependListener(event: string | symbol, listener: (...args: any[]) => void)
Parameters
Parameters
NameTypeDescription
event
string | symbol
listener
(...args: any[]) => void
Returns
this

prependOnceListener()​

Inherited from Emitter.prependOnceListener
Preview
prependOnceListener(event: string | symbol, listener: (...args: any[]) => void)
Parameters
Parameters
NameTypeDescription
event
string | symbol
listener
(...args: any[]) => void
Returns
this

rawListeners()​

Inherited from Emitter.rawListeners
Preview
rawListeners(event: string | symbol)
Parameters
Parameters
NameTypeDescription
event
string | symbol
Returns
Function[]

removeAllListeners()​

Inherited from Emitter.removeAllListeners
Preview
removeAllListeners(event: string | symbol)
Parameters
Parameters
NameTypeDescription
event
string | symbol
Returns
this

setMaxListeners()​

Inherited from Emitter.setMaxListeners
Preview
setMaxListeners(n: number)
Parameters
Parameters
NameTypeDescription
n
number
Returns
this

listenerCount()​

Inherited from Emitter.listenerCount
Preview
listenerCount(emitter: EventEmitter, event: string | symbol)
Parameters
Parameters
NameTypeDescription
emitter
EventEmitter
event
string | symbol
Returns
number