Interface ObjectStore

Hierarchy

ObjectStore

Index

Methods

delete destroy get getBlob info link linkStore list put putBlob seal status update watch

Methods

delete

delete(name: string): Promise<PurgeResponse>
Deletes the specified entry from the object store.
Parameters
- name: string
Returns Promise<PurgeResponse>
- Defined in cjs/jetstream/types.ts:1536

destroy

destroy(): Promise<boolean>
Destroys the object store and all its entries.

Returns Promise<boolean>
- Defined in cjs/jetstream/types.ts:1586

get

get(name: string): Promise<ObjectResult>
Returns an object you can use for reading the data from the named stored object or null if the entry doesn't exist.
Parameters
- name: string
Returns Promise<ObjectResult>
- Defined in cjs/jetstream/types.ts:1503

getBlob

getBlob(name: string): Promise<Uint8Array>
Returns the data stored for the named entry.
Parameters
- name: string
Returns Promise<Uint8Array>
- Defined in cjs/jetstream/types.ts:1508

info

info(name: string): Promise<ObjectInfo>
Returns the ObjectInfo of the named entry. Or null if the entry doesn't exist.
Parameters
- name: string
Returns Promise<ObjectInfo>
- Defined in cjs/jetstream/types.ts:1493

link

link(name: string, meta: ObjectInfo): Promise<ObjectInfo>
Adds a link to another object in the same store or a different one. Note that links of links are rejected. object.
Parameters
- name: string
- meta: ObjectInfo
Returns Promise<ObjectInfo>
- Defined in cjs/jetstream/types.ts:1545

linkStore

linkStore(name: string, bucket: ObjectStore): Promise<ObjectInfo>
Add a link to another object store
Parameters
- name: string
- bucket: ObjectStore
Returns Promise<ObjectInfo>
- Defined in cjs/jetstream/types.ts:1552

list

list(): Promise<ObjectInfo[]>
Returns a list of the entries in the ObjectStore

Returns Promise<ObjectInfo[]>
- Defined in cjs/jetstream/types.ts:1497

put

put(meta: ObjectStoreMeta, rs: ReadableStream<Uint8Array>, opts?: ObjectStorePutOpts): Promise<ObjectInfo>
Adds an object to the store with the specified meta and using the specified ReadableStream to stream the data.
Parameters
- meta: ObjectStoreMeta
- rs: ReadableStream<Uint8Array>
- Optional opts: ObjectStorePutOpts
Returns Promise<ObjectInfo>
- Defined in cjs/jetstream/types.ts:1516

putBlob

putBlob(meta: ObjectStoreMeta, data: Uint8Array, opts?: ObjectStorePutOpts): Promise<ObjectInfo>
Puts the specified bytes into the store with the specified meta.
Parameters
- meta: ObjectStoreMeta
- data: Uint8Array
- Optional opts: ObjectStorePutOpts
Returns Promise<ObjectInfo>
- Defined in cjs/jetstream/types.ts:1527

seal

seal(): Promise<ObjectStoreStatus>
Seals the object store preventing any further modifications.

Returns Promise<ObjectStoreStatus>
- Defined in cjs/jetstream/types.ts:1569

status

status(opts?: Partial<StreamInfoRequestOptions>): Promise<ObjectStoreStatus>
Returns the runtime status of the object store.
Parameters
- Optional opts: Partial<StreamInfoRequestOptions>
Returns Promise<ObjectStoreStatus>
- Defined in cjs/jetstream/types.ts:1574

update

update(name: string, meta: Partial<ObjectStoreMeta>): Promise<PubAck>
Update the metadata for an object. If the name is modified, the object is effectively renamed and will only be accessible by its new name.
Parameters
- name: string
- meta: Partial<ObjectStoreMeta>
Returns Promise<PubAck>
- Defined in cjs/jetstream/types.ts:1582

watch

watch(opts?: Partial<{
ignoreDeletes?: boolean;
includeHistory?: boolean;
}>): Promise<QueuedIterator<ObjectInfo>>
Watch an object store and receive updates of modifications via an iterator.
Parameters
- Optional opts: Partial<{
  ignoreDeletes?: boolean;
  includeHistory?: boolean;
  }>
Returns Promise<QueuedIterator<ObjectInfo>>
- Defined in cjs/jetstream/types.ts:1558

Generated using TypeDoc