Skip to main content
Deno 2 is finally here 🎉️
Learn more
Go to Latest
interface SubOpts
import { type SubOpts } from "https://deno.land/x/natsws@v1.28.0/src/nats-base-client.ts";

Subscription Options

Properties

optional
queue: string

Optional queue name (subscriptions on the same subject that use queues are horizontally load balanced when part of the same queue).

optional
max: number

Optional maximum number of messages to deliver to the subscription before it is auto-unsubscribed.

optional
timeout: number

Optional maximum number of milliseconds before a timer raises an error. This useful to monitor a subscription that is expected to yield messages. The timer is cancelled when the first message is received by the subscription.

optional
callback: (err: NatsError | null, msg: T) => void

An optional function that will handle messages. Typically, messages are processed via an async iterator on the subscription. If this option is provided, messages are processed by the specified function.