Interface ConsumerMessages

interface ConsumerMessages {
    [asyncIterator](): AsyncIterator<JsMsg, any, undefined>;
    close(): Promise<void | Error>;
    closed(): Promise<void | Error>;
    getPending(): number;
    getProcessed(): number;
    getReceived(): number;
    status(): Promise<AsyncIterable<ConsumerStatus>>;
    stop(err?: Error): void;
}

Hierarchy

  • QueuedIterator<JsMsg>
  • Close
    • ConsumerMessages

Methods

[asyncIterator] close closed getPending getProcessed getReceived status stop

Methods

[asyncIterator]

  • [asyncIterator](): AsyncIterator<JsMsg, any, undefined>

  • Returns AsyncIterator<JsMsg, any, undefined>

close

  • close(): Promise<void | Error>

  • Returns Promise<void | Error>

closed

  • closed(): Promise<void | Error>

  • Returns Promise<void | Error>

getPending

  • getPending(): number

  • Returns number

getProcessed

  • getProcessed(): number

  • Returns number

getReceived

  • getReceived(): number

  • Returns number

status

stop

  • stop(err?): void

  • Parameters

    • Optionalerr: Error

    Returns void

Settings

Member Visibility

On This Page

Methods