Skip to main content
Using Deno in production at your company? Earn free Deno merch.
Give us feedback
Module

x/natsws/src/mod.ts>ConsumerConfig

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

Properties

ack_policy: AckPolicy

The type of acknowledgment required by the Consumer

deliver_policy: DeliverPolicy

Where to start consuming messages on the stream

optional
deprecated
deliver_group: string

Allows push consumers to form a queue group

optional
durable_name: string

A unique name for a durable consumer Set name - for ephemeral consumers, also set idle_heartbeat

optional
name: string

The consumer name

optional
flow_control: boolean

For push consumers this will regularly send an empty mess with Status header 100 and a reply subject, consumers must reply to these messages to control the rate of message delivery.

optional
idle_heartbeat: Nanos

If the Consumer is idle for more than this many nanoseconds an empty message with Status header 100 will be sent indicating the consumer is still alive

optional
opt_start_seq: number

The sequence from which to start delivery messages. Requires DeliverPolicy#StartSequence

optional
opt_start_time: string

The date time from which to start delivering messages Requires DeliverPolicy#StartTime

optional
rate_limit_bps: number

The rate at which messages will be delivered to clients, expressed in bytes per second

replay_policy: ReplayPolicy

How messages are played back to the Consumer

optional
pause_until: string

Creates a consumer that is initially paused, but will resume at the specified Date and time. Specified as an ISO date time string (Date#toISOString()).