Class MessageCollector

Hierarchy

MessageCollector

Index

Constructors

Properties

#runner? contexts ctx key options validate

Accessors

maxMessages time

Methods

#onEnd destroy start wait

Constructors

constructor

new MessageCollector(ctx: Context, options?: CollectorOptions): MessageCollector
Parameters
- ctx: Context
  
  A context of message
- options: CollectorOptions = ...
Returns MessageCollector
- Defined in src/structures/collector.ts:24

Properties

`Private` `Optional` #runner

#runner?: Timeout

contexts

contexts: Context[] = []

Collected context

ctx

A context of message

`Private` key

key: string

Message collector session key

`Private` options

options: CollectorOptions = ...

validate

validate: ((ctx: Context) => boolean | Promise<boolean>)

Type declaration

- (ctx: Context): boolean | Promise<boolean>
- Validate a message function
  Parameters
  - ctx: Context
  Returns boolean | Promise<boolean>

Accessors

maxMessages

get maxMessages(): number
Get the maximum messages want to receive.

Returns

Returns number
- Defined in src/structures/collector.ts:61

time

get time(): number
Get the waiting time.

Returns

Returns number
- Defined in src/structures/collector.ts:52

Methods

`Private` #onEnd

#onEnd(state: CollectorEventState, _collector: MessageCollector, resolve: _resolvefunc): void
Just end function.

Returns
Parameters
- state: CollectorEventState
  
  Collector event state.
- _collector: MessageCollector
  
  Message collector class
- resolve: _resolvefunc
  
  resolve function.
Returns void
- Defined in src/structures/collector.ts:114

destroy

destroy(): void
Destroy the message collector session.

Returns

Returns void
- Defined in src/structures/collector.ts:87

start

start(): void
Start the message collector

Returns

Returns void
- Defined in src/structures/collector.ts:70

wait

wait(): Promise<boolean>
Wait message collector until 'end' event is fired.

Returns Promise<boolean>
- Defined in src/structures/collector.ts:101

Generated using TypeDoc