Class Collector<T>`Abstract`

A collector is just a wrapper over a set of events for collecting a structure. Commonly used for things like Message or MessageReaction collecting, collectors allow you to have your code wait until further input from a user.

Type Parameters

T extends CollectableStructure

Hierarchy

Collector

Index

Constructors

constructor

new Collector<T>(client, options): Collector<T>
Type Parameters
- T extends CollectableStructure
Parameters
- client: Client
- options: Partial<CollectorOptions<T>>
Returns Collector<T>
- Defined in guilded.js/lib/structures/collectors/Collector.ts:30

Properties

`Protected` boundItemReceiver

boundItemReceiver: ((entry) => Promise<boolean>) = ...

Type declaration

- (entry): Promise<boolean>
- Bound function for item receiving
  Parameters
  - entry: T
  Returns Promise<boolean>

`Readonly` client

client: Client

emitter

emitter: TypedEventEmitter<CollectorEvents<T>> = ...

`Readonly` entries

entries: Collection<T["id"], T> = ...

Collection of successfully collected entries

isActive

isActive: boolean = false

Whether the collector is actively collecting elements

`Protected` maxTimeout

maxTimeout: null | Timeout = null

Timeout for max time

options

options: Partial<CollectorOptions<T>>

`Protected` resolve

resolve: null | ((value) => void) = null

Method to resolve the promise this collector has when instantiated

Methods

`Abstract` _cleanup

_cleanup(): void
Clean up the collector

Returns void
- Defined in guilded.js/lib/structures/collectors/Collector.ts:124

`Protected` decrementMaxEventListeners

decrementMaxEventListeners(): number
Decrement the max number of event listeners for the client

Returns number
The new max number of event listeners for the client
- Defined in guilded.js/lib/structures/collectors/Collector.ts:106

`Abstract` hookEvents

hookEvents(): void
Hook events to the collector

Returns void
- Defined in guilded.js/lib/structures/collectors/Collector.ts:119

`Protected` incrementMaxEventListeners

incrementMaxEventListeners(): number
Increment the max number of event listeners for the client

Returns number
The new max number of event listeners for the client
- Defined in guilded.js/lib/structures/collectors/Collector.ts:95

itemReceived

itemReceived(entry): Promise<boolean>
Receives an item
Parameters
- entry: T
  
  The item received
Returns Promise<boolean>
Whether the item passes the filter function or not
- Defined in guilded.js/lib/structures/collectors/Collector.ts:67

start

start(): Promise<CollectorReturnValue<T>>
Start the collector

Returns Promise<CollectorReturnValue<T>>
A promise that resolves with a CollectorReturnValue object
- Defined in guilded.js/lib/structures/collectors/Collector.ts:43

Class Collector<T>Abstract

Type Parameters

T extends CollectableStructure

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

T extends CollectableStructure

Parameters

client: Client

options: Partial<CollectorOptions<T>>

Returns Collector<T>

Properties

Protected boundItemReceiver

Type declaration

Parameters

entry: T

Returns Promise<boolean>

Readonly client

emitter

Readonly entries

isActive

Protected maxTimeout

options

Protected resolve

Methods

Abstract _cleanup

Returns void

Protected decrementMaxEventListeners

Returns number

Abstract hookEvents

Returns void

Protected incrementMaxEventListeners

Returns number

itemReceived

Parameters

entry: T

Returns Promise<boolean>

start

Returns Promise<CollectorReturnValue<T>>

Settings

Member Visibility

Theme

On This Page

Class Collector<T>`Abstract`

`Protected` boundItemReceiver

`Readonly` client

`Readonly` entries

`Protected` maxTimeout

`Protected` resolve

`Abstract` _cleanup

`Protected` decrementMaxEventListeners

`Abstract` hookEvents

`Protected` incrementMaxEventListeners