Interface GetChannelMessagesIteratorOptions<T>

Type Parameters

T extends AnyTextableChannel | Uncached = AnyTextableChannel | Uncached

Hierarchy

GetChannelMessagesIteratorOptions

Index

Methods

Properties

after? before? limit?

Methods

`Optional` filter

filter(message): boolean | "break" | PromiseLike<boolean | "break">
A function used to reject certain messages. If "break" is returned, the iterator will immediately exit and yield the previously allowed messages.
Parameters
- message: Message<T>
  
  The message to filter.
Returns boolean | "break" | PromiseLike<boolean | "break">
- Defined in lib/types/channels.d.ts:813

Properties

`Optional` after

after?: string

Get messages after this message ID. IDs don't need to be valid, an ID can be generated for any timestamp via Base#generateID.

`Optional` before

before?: string

Get messages before this message ID. IDs don't need to be valid, an ID can be generated for any timestamp via Base#generateID.

`Optional` limit

limit?: number

The maximum amount of messages to get. Defaults to 100. Use Infinity if you wish to get as many messages as possible.