Class Collector<Model>

The collector of a data model.

Example

new Collector(client);

Type Parameters

  • Model extends Base<any>

Hierarchy

Constructors

constructor

Properties

client collected createdAt endedAt? options

Accessors

createdTimestamp endedTimestamp isEnded uptime

Methods

collect dispose emit end

Constructors

constructor

  • Type Parameters

    • Model extends Base<any, Model>

    Parameters

    • client: Client

      The client the collector belongs to.

    • Optional options: CollectorOptions<Model>

      The options of the collector.

    Returns Collector<Model>

Properties

Readonly client

client: Client

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>

Accessors

createdTimestamp

  • get createdTimestamp(): number

  • The timestamp the collector was created.

    Returns number

endedTimestamp

  • get endedTimestamp(): undefined | number

  • The timestamp the collector was ended.

    Returns undefined | number

isEnded

  • get isEnded(): boolean

  • Whether the collector has ended.

    Returns boolean

uptime

  • get uptime(): number

  • The time the collector has been running.

    Returns number

Methods

collect

  • Collect a item.

    Returns

    The collected item.

    Example

    collector.collect(item);

    Parameters

    • item: Model

      The item to collect.

    Returns Promise<undefined | Model>

dispose

  • 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

emit

  • Type Parameters

    Parameters

    Returns boolean

end

  • End the collector.

    Example

    collector.end();

    Returns void

Settings

Member Visibility

Theme