Skip to content
This is the alpha v4 version website. Looking for the v3 documentation?

TypedEventEmitter

Defined in: packages/sigma/src/types.ts:263

Extends

  • ITypedEventEmitter<Events, this>

Extended by

Type Parameters

Events

Events extends EventsMapping

Constructors

Constructor

new TypedEventEmitter<Events>(): TypedEventEmitter<Events>

Defined in: packages/sigma/src/types.ts:266

Returns

TypedEventEmitter<Events>

Overrides

(EventEmitter as unknown as { new <T extends EventsMapping>(): ITypedEventEmitter<T>; })<Events>.constructor

Properties

rawEmitter

rawEmitter: EventEmitter

Defined in: packages/sigma/src/types.ts:244

Inherited from

Sigma.rawEmitter

Methods

addListener()

addListener<Event>(type, listener): this

Defined in: packages/sigma/src/types.ts:250

Type Parameters

Event

Event extends string | number | symbol

Parameters

type

Event

listener

Events[Event]

Returns

this

Inherited from

(EventEmitter as unknown as { new <T extends EventsMapping>(): ITypedEventEmitter<T>; }).addListener


emit()

emit<Event>(type, …args): boolean

Defined in: packages/sigma/src/types.ts:249

Type Parameters

Event

Event extends string | number | symbol

Parameters

type

Event

args

Parameters<Events[Event]>

Returns

boolean

Inherited from

(EventEmitter as unknown as { new <T extends EventsMapping>(): ITypedEventEmitter<T>; }).emit


eventNames()

eventNames<Event>(): Event[]

Defined in: packages/sigma/src/types.ts:246

Type Parameters

Event

Event extends string | number | symbol

Returns

Event[]

Inherited from

(EventEmitter as unknown as { new <T extends EventsMapping>(): ITypedEventEmitter<T>; }).eventNames


getMaxListeners()

getMaxListeners(): number

Defined in: packages/sigma/src/types.ts:248

Returns

number

Inherited from

(EventEmitter as unknown as { new <T extends EventsMapping>(): ITypedEventEmitter<T>; }).getMaxListeners


listenerCount()

listenerCount<Event>(type): number

Defined in: packages/sigma/src/types.ts:259

Type Parameters

Event

Event extends string | number | symbol

Parameters

type

Event

Returns

number

Inherited from

(EventEmitter as unknown as { new <T extends EventsMapping>(): ITypedEventEmitter<T>; }).listenerCount


listeners()

listeners<Event>(type): Events[Event][]

Defined in: packages/sigma/src/types.ts:258

Type Parameters

Event

Event extends string | number | symbol

Parameters

type

Event

Returns

Events[Event][]

Inherited from

(EventEmitter as unknown as { new <T extends EventsMapping>(): ITypedEventEmitter<T>; }).listeners


off()

off<Event>(type, listener): this

Defined in: packages/sigma/src/types.ts:256

Type Parameters

Event

Event extends string | number | symbol

Parameters

type

Event

listener

Events[Event]

Returns

this

Inherited from

(EventEmitter as unknown as { new <T extends EventsMapping>(): ITypedEventEmitter<T>; }).off


on()

on<Event>(type, listener): this

Defined in: packages/sigma/src/types.ts:251

Type Parameters

Event

Event extends string | number | symbol

Parameters

type

Event

listener

Events[Event]

Returns

this

Inherited from

(EventEmitter as unknown as { new <T extends EventsMapping>(): ITypedEventEmitter<T>; }).on


once()

once<Event>(type, listener): this

Defined in: packages/sigma/src/types.ts:252

Type Parameters

Event

Event extends string | number | symbol

Parameters

type

Event

listener

Events[Event]

Returns

this

Inherited from

(EventEmitter as unknown as { new <T extends EventsMapping>(): ITypedEventEmitter<T>; }).once


prependListener()

prependListener<Event>(type, listener): this

Defined in: packages/sigma/src/types.ts:253

Type Parameters

Event

Event extends string | number | symbol

Parameters

type

Event

listener

Events[Event]

Returns

this

Inherited from

(EventEmitter as unknown as { new <T extends EventsMapping>(): ITypedEventEmitter<T>; }).prependListener


prependOnceListener()

prependOnceListener<Event>(type, listener): this

Defined in: packages/sigma/src/types.ts:254

Type Parameters

Event

Event extends string | number | symbol

Parameters

type

Event

listener

Events[Event]

Returns

this

Inherited from

(EventEmitter as unknown as { new <T extends EventsMapping>(): ITypedEventEmitter<T>; }).prependOnceListener


rawListeners()

rawListeners<Event>(type): Events[Event][]

Defined in: packages/sigma/src/types.ts:260

Type Parameters

Event

Event extends string | number | symbol

Parameters

type

Event

Returns

Events[Event][]

Inherited from

(EventEmitter as unknown as { new <T extends EventsMapping>(): ITypedEventEmitter<T>; }).rawListeners


removeAllListeners()

removeAllListeners<Event>(type?): this

Defined in: packages/sigma/src/types.ts:257

Type Parameters

Event

Event extends string | number | symbol

Parameters

type?

Event

Returns

this

Inherited from

(EventEmitter as unknown as { new <T extends EventsMapping>(): ITypedEventEmitter<T>; }).removeAllListeners


removeListener()

removeListener<Event>(type, listener): this

Defined in: packages/sigma/src/types.ts:255

Type Parameters

Event

Event extends string | number | symbol

Parameters

type

Event

listener

Events[Event]

Returns

this

Inherited from

(EventEmitter as unknown as { new <T extends EventsMapping>(): ITypedEventEmitter<T>; }).removeListener


setMaxListeners()

setMaxListeners(n): this

Defined in: packages/sigma/src/types.ts:247

Parameters

n

number

Returns

this

Inherited from

(EventEmitter as unknown as { new <T extends EventsMapping>(): ITypedEventEmitter<T>; }).setMaxListeners