Class Collector<Model>

The collector of a data model.

Example

new Collector(client);

Type Parameters

Model extends Base<any>

Hierarchy

EventEmitter
- Collector
  - MessageCollector
  - MessageReactionCollector

Index

Constructors

constructor

new Collector<Model>(client: Client, options?: CollectorOptions<Model>): Collector<Model>
Type Parameters
- Model extends Base<any, Model>
Parameters
- client: Client
  
  The client the collector belongs to.
- options: CollectorOptions<Model> = {}
  
  The options of the collector.
Returns Collector<Model>
Overrides EventEmitter.constructor
- Defined in guilded.ts/src/collectors/Collector.ts:24

Properties

`Readonly` client

client: Client

The client the collector belongs to.

`Readonly` collected

collected: Collection<Model["id"], Model>

The collected data.

`Readonly` createdAt

createdAt: Date

The date the collector was created.

`Optional` endedAt

endedAt?: Date

The date the collector was ended.

`Readonly` options

options: CollectorOptions<Model> = {}

The options of the collector.

Accessors

createdTimestamp

get createdTimestamp(): number
The timestamp the collector was created.

Returns number
- Defined in guilded.ts/src/collectors/Collector.ts:36

endedTimestamp

get endedTimestamp(): undefined | number
The timestamp the collector was ended.

Returns undefined | number
- Defined in guilded.ts/src/collectors/Collector.ts:46

isEnded

get isEnded(): boolean
Whether the collector has ended.

Returns boolean
- Defined in guilded.ts/src/collectors/Collector.ts:41

uptime

get uptime(): number
The time the collector has been running.

Returns number
- Defined in guilded.ts/src/collectors/Collector.ts:51

Methods

collect

collect(item: Model): Promise<undefined | Model>
Collect a item.

Returns
The collected item.

Example
```
collector.collect(item);
```
Parameters
- item: Model
  
  The item to collect.
Returns Promise<undefined | Model>
- Defined in guilded.ts/src/collectors/Collector.ts:73

dispose

dispose(itemId: Model["id"]): undefined | Model
Dispose a collected item.

Returns
The disposed item.

Example
```
collector.dispose('abc');
```
Parameters
- itemId: Model["id"]
  
  The ID of the item to dispose.
Returns undefined | Model
- Defined in guilded.ts/src/collectors/Collector.ts:92

emit

emit<Event>(event: Event, ...args: CollectorEvents<Model>[Event]): boolean
Type Parameters
- Event extends keyof CollectorEvents<Model>
Parameters
- event: Event
- Rest ...args: CollectorEvents<Model>[Event]
Returns boolean
Inherited from EventEmitter.emit
- Defined in guilded.ts/src/collectors/Collector.ts:117

end

end(): void
End the collector.

Example
```
collector.end();
```
Returns void
- Defined in guilded.ts/src/collectors/Collector.ts:61

Class Collector<Model>

Example

Type Parameters

Model extends Base<any>

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Model extends Base<any, Model>

Parameters

client: Client

options: CollectorOptions<Model> = {}

Returns Collector<Model>

Properties

Readonly client

Readonly collected

Readonly createdAt

Optional endedAt

Readonly options

Accessors

createdTimestamp

Returns number

endedTimestamp

Returns undefined | number

isEnded

Returns boolean

uptime

Returns number

Methods

collect

Returns

Example

Parameters

item: Model

Returns Promise<undefined | Model>

dispose

Returns

Example

Parameters

itemId: Model["id"]

Returns undefined | Model

emit

Type Parameters

Event extends keyof CollectorEvents<Model>

Parameters

event: Event

Rest ...args: CollectorEvents<Model>[Event]

Returns boolean

end

Example

Returns void

Settings

Member Visibility

Theme

`Readonly` client

`Readonly` collected

`Readonly` createdAt

`Optional` endedAt

`Readonly` options

`Rest` ...args: CollectorEvents<Model>[Event]