Interface Consumers


  • Consumers



  • Returns the Consumer configured for the specified stream having the specified name. Consumers are typically created with JetStreamManager. If no name is specified, the Consumers API will return an ordered consumer.

    An ordered consumer expects messages to be delivered in order. If there's any inconsistency, the ordered consumer will recreate the underlying consumer at the correct sequence. Note that ordered consumers don't yield messages that can be acked because the client can simply recreate the consumer.



    • stream: string
    • Optional name: string | Partial<OrderedConsumerOptions>

      or OrderedConsumerOptions - if not specified an ordered consumer is created with the specified options.

    Returns Promise<Consumer>

Generated using TypeDoc