Class Objm

constructor

• new Objm(nc: NatsConnection | JetStreamClient): Objm

  Creates an instance of the Objm that allows you to create and access ObjectStore. Note that if the argument is a NatsConnection, default JetStream Options are used. If you want to set some options, please provide a JetStreamClient instead.

  Parameters

  • nc: NatsConnection | JetStreamClient

  Returns Objm

js

create

• create(name: string, opts?: Partial<ObjectStoreOptions>): Promise<ObjectStore>

  Creates and opens the specified ObjectStore. If the ObjectStore already exists, it opens the existing ObjectStore.

  Parameters

  • name: string
  • opts: Partial<ObjectStoreOptions> = {}

  Returns Promise<ObjectStore>

list

• list(): Lister<ObjectStoreStatus>

  Returns a list of ObjectStoreStatus for all streams that are identified as being a ObjectStore (that is having names that have the prefix OBJ_)

  Returns Lister<ObjectStoreStatus>

open

• open(name: string, check?: boolean): Promise<ObjectStore>

  Opens the specified ObjectStore

  Parameters

  • name: string
  • check: boolean = true

    if set to false, it will not check if the ObjectStore exists.

  Returns Promise<ObjectStore>