Skip to main content

Interface: EventIteratorOptions<V>

@sapphire/event-iterator.EventIteratorOptions

Options to be passed to an EventIterator.

Type parameters

Name
V

Properties

filter

โ€ข Optional filter: EventIteratorFilter<V>

The filter.

Defined in

projects/utilities/packages/event-iterator/src/index.ts:16


idle

โ€ข Optional idle: number

The timeout in ms before ending the EventIterator.

Defined in

projects/utilities/packages/event-iterator/src/index.ts:21


limit

โ€ข Optional limit: number

The limit of events that pass the filter to iterate.

Defined in

projects/utilities/packages/event-iterator/src/index.ts:26