Skip to main content
Deno 2 is finally here 🎉️
Learn more
Module

x/natsws/src/mod.ts>ConsumerInfo

WebSocket NATS
nats-io/nats.ws
Latest
interface ConsumerInfo
import { type ConsumerInfo } from "https://deno.land/x/natsws@v1.29.2/src/mod.ts";

Properties

stream_name: string

The stream hosting the consumer

name: string

A unique name for the consumer, either machine generated or the durable name

created: string

The ISO timestamp when the Consumer was created

config: ConsumerConfig

The consumer configuration

delivered: SequenceInfo

The last message delivered from this Consumer

ack_floor: SequenceInfo

The highest contiguous acknowledged message

num_ack_pending: number

The number of messages pending acknowledgement but yet to acknowledged by the client.

num_redelivered: number

The number of redeliveries that have been performed

num_waiting: number

The number of pull consumers waiting for messages

num_pending: number

The number of messages left unconsumed in this Consumer

optional
cluster: ClusterInfo

The cluster where the consumer is defined

push_bound: boolean

Indicates if any client is connected and receiving messages from a push consumer

optional
ts: string

The ISO timestamp when the ConsumerInfo was generated. This field is only available on servers 2.10.x or better

optional
paused: boolean

Set to true if the consumer is paused. This field is only available on servers 2.11.x or better

pause_remaining: Nanos

If the consumer was paused with a resume date, this field specifies the amount of time in nanoseconds remaining until the consumer will be automatically resumed. This field is only available on servers 2.11.x or better