Skip to main content
Using Deno in production at your company? Earn free Deno merch.
Give us feedback
Go to Latest
interface ConsumerUpdateConfig
import { type ConsumerUpdateConfig } from "https://deno.land/x/natsws@v1.27.0/src/mod.ts";

Properties

optional
description: string

A short description of the purpose of this consume

optional
ack_wait: Nanos

How long (in nanoseconds) to allow messages to remain un-acknowledged before attempting redelivery

optional
max_deliver: number

The number of times a message will be redelivered to consumers if not acknowledged in time

optional
max_ack_pending: number

The maximum number of messages without acknowledgement that can be outstanding, once this limit is reached message delivery will be suspended

optional
max_waiting: number

The number of pulls that can be outstanding on a pull consumer, pulls received after this is reached are ignored

optional
headers_only: boolean

Delivers only the headers of messages in the stream and not the bodies. Additionally, adds Nats-Msg-Size JsHeaders#MessageSizeHdr header to indicate the size of the removed payload

optional
deprecated
deliver_subject: string

The subject where the push consumer should be sent the messages

optional
max_batch: number

The largest batch property that may be specified when doing a pull on a Pull Consumer

optional
max_expires: Nanos

The maximum expires value that may be set when doing a pull on a Pull Consumer

optional
inactive_threshold: Nanos

Duration that instructs the server to clean up ephemeral consumers that are inactive for that long

optional
backoff: Nanos[]

List of durations in nanoseconds format that represents a retry timescale for NaK'd messages or those being normally retried

optional
max_bytes: number

The maximum bytes value that maybe set when dong a pull on a Pull Consumer

optional
num_replicas: number

When set do not inherit the replica count from the stream but specifically set it to this amount.

optional
mem_storage: boolean

Force the consumer state to be kept in memory rather than inherit the setting from the stream

optional
filter_subject: string

Deliver only messages that match the subject filter This is exclusive of filter_subjects

optional
filter_subjects: string[]

Deliver only messages that match the specified filters. This is exclusive of filter_subject.

optional
metadata: Record<string, string>

Metadata field to store additional information about the consumer. Note that keys starting with _nats are reserved. This feature only supported on servers 2.10.x and better.