Class: EventIterator<V>

An EventIterator, used for asynchronously iterating over received values.

Type Parameters

Type Parameter
V extends unknown[]

Implements

• AsyncIterableIterator<V>

Constructors

new EventIterator()

new EventIterator<V>(emitter: EventEmitter<DefaultEventMap>, event: string, options: EventIteratorOptions<V>): EventIterator<V>

Parameters

Parameter	Type	Description
emitter	EventEmitter<DefaultEventMap>	The event emitter to listen to.
event	string	The event we're listening for to receives values from.
options	EventIteratorOptions<V>	Any extra options.

Returns

EventIterator<V>

Defined in

index.ts:87

Properties

emitter

readonly emitter: EventEmitter<DefaultEventMap>

The emitter to listen to.

Defined in

index.ts:35

---

event

readonly event: string

The event the event iterator is listening for to receive values from.

Defined in

index.ts:40

---

filter

filter: EventIteratorFilter<V>

The filter used to filter out values.

Defined in

index.ts:45

Accessors

ended

get ended(): boolean

Whether or not the EventIterator has ended.

Returns

boolean

Defined in

index.ts:107

Methods

[asyncIterator]()

[asyncIterator](): AsyncIterableIterator<V>

The symbol allowing EventIterators to be used in for-await-of loops.

Returns

AsyncIterableIterator<V>

Implementation of

AsyncIterableIterator.[asyncIterator]

Defined in

index.ts:184

---

end()

end(): void

Ends the EventIterator.

Returns

void

Defined in

index.ts:114

---

next()

next(): Promise<IteratorResult<V, any>>

The next value that's received from the EventEmitter.

Returns

Promise<IteratorResult<V, any>>

Implementation of

AsyncIterableIterator.next

Defined in

index.ts:127

---

push()

protected push(...value: V): void

Pushes a value into the queue.

Parameters

Parameter	Type
...value	V

Returns

void

Defined in

index.ts:191

---

return()

return(): Promise<IteratorResult<V, any>>

Handles what happens when you break or return from a loop.

Returns

Promise<IteratorResult<V, any>>

Implementation of

AsyncIterableIterator.return

Defined in

index.ts:168

---

throw()

throw(): Promise<IteratorResult<V, any>>

Handles what happens when you encounter an error in a loop.

Returns

Promise<IteratorResult<V, any>>

Implementation of

AsyncIterableIterator.throw

Defined in

index.ts:176