Interface MessageCollector<T>

Stateful message collector used for streaming replies/messages.

interface MessageCollector<T = unknown> {
    collected: ReadonlyMap<string, T>;
    ended: boolean;
    off<K extends keyof MessageCollectorEvents<T>>(
        event: K,
        listener: MessageCollectorEvents<T>[K],
    ): this;
    on<K extends keyof MessageCollectorEvents<T>>(
        event: K,
        listener: MessageCollectorEvents<T>[K],
    ): this;
    once<K extends keyof MessageCollectorEvents<T>>(
        event: K,
        listener: MessageCollectorEvents<T>[K],
    ): this;
    stop(reason?: CollectorEndReason): void;
}

Type Parameters

T = unknown

Implemented by

ConduitMessageCollector

Index

Properties

collected ended

Methods

off on once stop

Properties

`Readonly`collected

collected: ReadonlyMap<string, T>

`Readonly`ended

ended: boolean

Methods

off

off<K extends keyof MessageCollectorEvents<T>>(
event: K,
listener: MessageCollectorEvents<T>[K],
): this
Type Parameters
- K extends keyof MessageCollectorEvents<T>
Parameters
- event: K
- listener: MessageCollectorEvents<T>[K]
Returns this
- Defined in src/types.ts:217

on

on<K extends keyof MessageCollectorEvents<T>>(
event: K,
listener: MessageCollectorEvents<T>[K],
): this
Type Parameters
- K extends keyof MessageCollectorEvents<T>
Parameters
- event: K
- listener: MessageCollectorEvents<T>[K]
Returns this
- Defined in src/types.ts:209

once

once<K extends keyof MessageCollectorEvents<T>>(
event: K,
listener: MessageCollectorEvents<T>[K],
): this
Type Parameters
- K extends keyof MessageCollectorEvents<T>
Parameters
- event: K
- listener: MessageCollectorEvents<T>[K]
Returns this
- Defined in src/types.ts:213

stop

stop(reason?: CollectorEndReason): void
Parameters
- Optionalreason: CollectorEndReason
Returns void
- Defined in src/types.ts:208