Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MessageIterator

An asynchronous iterator responsible for iterating over messages.

since

0.0.1

Hierarchy

  • EventIterator<[Message]>
    • MessageIterator

Implements

Index

Constructors

constructor

Properties

Private #private

#private: any

Readonly emitter

emitter: EventEmitter

event

event: string

filter

filter: EventIteratorFilter<[Message]>

The filter used to filter out values.

Accessors

ended

  • get ended(): boolean
  • Whether or not the EventIterator has ended.

    Returns boolean

Methods

[Symbol.asyncIterator]

  • [Symbol.asyncIterator](): AsyncIterableIterator<[Message]>
  • The symbol allowing EventIterators to be used in for-await-of loops.

    Returns AsyncIterableIterator<[Message]>

end

  • end(): void
  • Ends the EventIterator.

    Returns void

next

  • next(): Promise<IteratorResult<[Message]>>
  • The next value that's received from the EventEmitter.

    Returns Promise<IteratorResult<[Message]>>

Protected push

  • Pushes a value into the queue.

    Parameters

    Returns void

return

  • return(): Promise<IteratorResult<[Message]>>
  • Handles what happens when you break or return from a loop.

    Returns Promise<IteratorResult<[Message]>>

throw

  • throw(): Promise<IteratorResult<[Message]>>
  • Handles what happens when you encounter an error in a loop.

    Returns Promise<IteratorResult<[Message]>>

Generated using TypeDoc