KvOptions | /src/mod.ts | natsws@v1.28.0

Module

x/natsws/src/mod.ts>KvOptions

WebSocket NATS

nats-io/nats.ws

Latest

mod.ts (default module)

JetStreamAccountStats

JetStreamApiStats

JetStreamClient

JetStreamManager

JetStreamManagerOptions

JetStreamOptions

JetStreamPublishOptions

JetStreamUsageAccountLimits

Msg

Sub

SubjectTransformConfig

TypedSubscriptionOptions

UserPass

Views

AbortOnMissingResource

IngestionFilterFnResult

JetStreamPullSubscription

JetStreamSubscription

JetStreamSubscriptionOptions

ObjectStoreMetaOptions

ObjectStoreOptions

ObjectStorePutOpts

ObjectStoreStatus

OrderedConsumerOptions

StreamInfoRequestOptions

ServiceErrorCodeHeader

ServiceErrorHeader

backoff

buildAuthenticator

canonicalMIMEHeaderKey

usernamePasswordAuthenticator

Msg

Sub

TypedSubscriptionOptions

IngestionFilterFnResult

ServiceErrorCodeHeader

canonicalMIMEHeaderKey

checkOptions

checkUnsupportedOption

extractProtocolMessage

usernamePasswordAuthenticator

interface KvOptions

implements KvLimits

import { type KvOptions } from "https://deno.land/x/natsws@v1.28.0/src/mod.ts";

Properties

timeout: number

How long to wait in milliseconds for a response from the KV

streamName: string

The underlying stream name for the KV

codec: KvCodecs

An encoder/decoder for keys and values

bindOnly: boolean

Doesn't attempt to create the KV stream if it doesn't exist.

allow_direct: boolean

If true and on a recent server, changes the way the KV retrieves values. This option is significantly faster, but has the possibility of inconsistency during a read.

optional

metadata: Record<string, string>

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