Class Bucket

constructor

• new Bucket(bucket: string, js: JetStreamClient, jsm: JetStreamManager): Bucket

  Parameters

  • bucket: string
  • js: JetStreamClient
  • jsm: JetStreamManager

  Returns Bucket

_prefixLen

bucket

codec

direct

editPrefix

hasWildcards

js

jsm

prefix

stream

useJsPrefix

validateKey

validateSearchKey

prefixLen

• get prefixLen(): number

  Returns number

_buildCC

• _buildCC(
      k: string | string[],
      content: KvWatchInclude,
      opts?: Partial<ConsumerConfig>,
  ): Partial<ConsumerConfig>

  Parameters

  • k: string | string[]
  • content: KvWatchInclude
  • opts: Partial<ConsumerConfig> = {}

  Returns Partial<ConsumerConfig>

_deleteOrPurge

• _deleteOrPurge(
      k: string,
      op: "DEL" | "PURGE",
      opts?: Partial<KvDeleteOptions>,
  ): Promise<void>

  Parameters

  • k: string
  • op: "DEL" | "PURGE"
  • Optionalopts: Partial<KvDeleteOptions>

  Returns Promise<void>

_doDeleteOrPurge

• _doDeleteOrPurge(
      k: string,
      op: "DEL" | "PURGE",
      opts?: Partial<KvDeleteOptions>,
  ): Promise<void>

  Parameters

  • k: string
  • op: "DEL" | "PURGE"
  • Optionalopts: Partial<KvDeleteOptions>

  Returns Promise<void>

_put

• _put(
      k: string,
      data: Payload,
      opts?: Partial<KvPutOptions>,
      markerTTL?: string,
  ): Promise<number>

  Parameters

  • k: string
  • data: Payload
  • opts: Partial<KvPutOptions> = {}
  • OptionalmarkerTTL: string

  Returns Promise<number>

bucketName

• bucketName(): string

  Returns string

canSetWatcherName

• canSetWatcherName(): boolean

  Returns boolean

close

• close(): Promise<void>

  Returns Promise<void>

create

• create(k: string, data: Payload, markerTTL?: string): Promise<number>

  Creates a new entry ensuring that the entry does not exist (or the current version is deleted or the key is purged) If the entry already exists, this operation fails.

  markerTTL is specified as a Go duration strings ("10s", "1m", "1h"...)

  Parameters

  • k: string
  • data: Payload
  • OptionalmarkerTTL: string

    duration is specified as a string

  Returns Promise<number>

dataLen

• dataLen(data: Uint8Array, h?: MsgHdrs): number

  Parameters

  • data: Uint8Array
  • Optionalh: MsgHdrs

  Returns number

decodeKey

• decodeKey(ekey: string): string

  Parameters

  • ekey: string

  Returns string

delete

• delete(k: string, opts?: Partial<KvDeleteOptions>): Promise<void>

  Deletes the entry stored under the specified key. Deletes are soft-deletes. The server will add a new entry marked by a "DEL" operation. Note that if the KV was created with an underlying limit (such as a TTL on keys) it is possible for a key or the soft delete marker to be removed without additional notification on a watch.

  Parameters

  • k: string
  • Optionalopts: Partial<KvDeleteOptions>

  Returns Promise<void>

destroy

• destroy(): Promise<boolean>

  Destroys the underlying stream used by the KV. This effectively deletes all data stored under the KV.

  Returns Promise<boolean>

encodeKey

• encodeKey(key: string): string

  Parameters

  • key: string

  Returns string

fullKeyName

• fullKeyName(k: string): string

  Parameters

  • k: string

  Returns string

get

• get(k: string, opts?: { revision: number }): Promise<KvEntry>

  Returns the KvEntry stored under the key if it exists or null if not. Note that the entry returned could be marked with a "DEL" or "PURGE" operation which signifies the server stored the value, but it is now deleted.

  Parameters

  • k: string
  • Optionalopts: { revision: number }

  Returns Promise<KvEntry>

history

• history(
      opts?: { headers_only?: boolean; key?: string | string[] },
  ): Promise<QueuedIterator<KvWatchEntry>>

  Returns an iterator of the specified key's history (or all keys). Note you can specify multiple keys if running on server 2.10.x or better.

  Parameters

  • opts: { headers_only?: boolean; key?: string | string[] } = {}

  Returns Promise<QueuedIterator<KvWatchEntry>>

init

• init(opts?: Partial<KvOptions>): Promise<void>

  Parameters

  • opts: Partial<KvOptions> = {}

  Returns Promise<void>

initializePrefixes

• initializePrefixes(info: StreamInfo): void

  Parameters

  • info: StreamInfo

  Returns void

jmToWatchEntry

• jmToWatchEntry(jm: JsMsg, isUpdate: boolean): KvWatchEntry

  Parameters

  • jm: JsMsg
  • isUpdate: boolean

  Returns KvWatchEntry

keys

• keys(k?: string | string[]): Promise<QueuedIterator<string>>

  Returns an iterator of all the keys optionally matching the specified filter.

  Parameters

  • k: string | string[] = ">"

  Returns Promise<QueuedIterator<string>>

purge

• purge(k: string, opts?: Partial<KvDeleteOptions>): Promise<void>

  Deletes and purges the specified key and any value history.

  Parameters

  • k: string
  • Optionalopts: Partial<KvDeleteOptions>

  Returns Promise<void>

purgeBucket

• purgeBucket(opts?: PurgeOpts): Promise<PurgeResponse>

  Parameters

  • Optionalopts: PurgeOpts

  Returns Promise<PurgeResponse>

purgeDeletes

• purgeDeletes(olderMillis?: number): Promise<PurgeResponse>

  Parameters

  • olderMillis: number = ...

  Returns Promise<PurgeResponse>

put

• put(k: string, data: Payload, opts?: Partial<KvPutOptions>): Promise<number>

  Sets or updates the value stored under the specified key.

  Parameters

  • k: string
  • data: Payload
  • opts: Partial<KvPutOptions> = {}

  Returns Promise<number>

remove

• remove(k: string): Promise<void>

  Parameters

  • k: string

  Returns Promise<void>

smToEntry

• smToEntry(sm: StoredMsg): KvEntry

  Parameters

  • sm: StoredMsg

  Returns KvEntry

status

• status(): Promise<KvStatus>

  Returns information about the Kv

  Returns Promise<KvStatus>

subjectForBucket

• subjectForBucket(): string

  Returns string

subjectForKey

• subjectForKey(k: string, edit?: boolean): string

  Parameters

  • k: string
  • edit: boolean = false

  Returns string

update

• update(
      k: string,
      data: Payload,
      version: number,
      timeout?: number,
  ): Promise<number>

  Updates the existing entry provided that the previous sequence for the Kv is at the specified version. This ensures that the KV has not been modified prior to the update.

  Parameters

  • k: string
  • data: Payload
  • version: number
  • Optionaltimeout: number

    in millis

  Returns Promise<number>

watch

• watch(opts?: KvWatchOptions): Promise<QueuedIterator<KvWatchEntry>>

  Returns an iterator that will yield KvEntry updates as they happen.

  Parameters

  • opts: KvWatchOptions = {}

  Returns Promise<QueuedIterator<KvWatchEntry>>

Staticbind

• bind(js: JetStreamClient, name: string, opts?: Partial<KvOptions>): Promise<KV>

  Parameters

  • js: JetStreamClient
  • name: string
  • opts: Partial<KvOptions> = {}

  Returns Promise<KV>

Staticcreate

• create(
      js: JetStreamClient,
      name: string,
      opts?: Partial<KvOptions>,
  ): Promise<KV>

  Creates a new entry ensuring that the entry does not exist (or the current version is deleted or the key is purged) If the entry already exists, this operation fails.

  markerTTL is specified as a Go duration strings ("10s", "1m", "1h"...)

  Parameters

  • js: JetStreamClient
  • name: string
  • opts: Partial<KvOptions> = {}

  Returns Promise<KV>