Interface ObjectStore

interface ObjectStore {
    delete(name: string): Promise<PurgeResponse>;
    destroy(): Promise<boolean>;
    get(name: string): Promise<ObjectResult>;
    getBlob(name: string): Promise<Uint8Array>;
    info(name: string): Promise<ObjectInfo>;
    link(name: string, meta: ObjectInfo): Promise<ObjectInfo>;
    linkStore(name: string, bucket: ObjectStore): Promise<ObjectInfo>;
    list(): Promise<ObjectInfo[]>;
    put(meta: ObjectStoreMeta, rs: ReadableStream<Uint8Array>, opts?: ObjectStorePutOpts): Promise<ObjectInfo>;
    putBlob(meta: ObjectStoreMeta, data: Uint8Array, opts?: ObjectStorePutOpts): Promise<ObjectInfo>;
    seal(): Promise<ObjectStoreStatus>;
    status(opts?: Partial<StreamInfoRequestOptions>): Promise<ObjectStoreStatus>;
    update(name: string, meta: Partial<ObjectStoreMeta>): Promise<PubAck>;
    watch(opts?: Partial<{
        ignoreDeletes?: boolean;
        includeHistory?: boolean;
    }>): Promise<QueuedIterator<ObjectInfo>>;
}

Methods

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

Methods

delete

  • delete(name): Promise<PurgeResponse>

  • Deletes the specified entry from the object store.

    Parameters

    • name: string

    Returns Promise<PurgeResponse>

destroy

  • destroy(): Promise<boolean>

  • Destroys the object store and all its entries.

    Returns Promise<boolean>

get

  • get(name): 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>

getBlob

  • getBlob(name): Promise<Uint8Array>

  • Returns the data stored for the named entry.

    Parameters

    • name: string

    Returns Promise<Uint8Array>

info

  • info(name): Promise<ObjectInfo>

  • Returns the ObjectInfo of the named entry. Or null if the entry doesn't exist.

    Parameters

    • name: string

    Returns Promise<ObjectInfo>

link

  • link(name, meta): 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

    Returns Promise<ObjectInfo>

linkStore

  • linkStore(name, bucket): Promise<ObjectInfo>

  • Add a link to another object store

    Parameters

    Returns Promise<ObjectInfo>

list

  • list(): Promise<ObjectInfo[]>

  • Returns a list of the entries in the ObjectStore

    Returns Promise<ObjectInfo[]>

put

  • put(meta, rs, opts?): Promise<ObjectInfo>

  • Adds an object to the store with the specified meta and using the specified ReadableStream to stream the data.

    Parameters

    Returns Promise<ObjectInfo>

putBlob

seal

status

  • status(opts?): Promise<ObjectStoreStatus>

  • Returns the runtime status of the object store.

    Parameters

    • Optionalopts: Partial<StreamInfoRequestOptions>

    Returns Promise<ObjectStoreStatus>

update

  • update(name, meta): 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

    Returns Promise<PubAck>

watch

  • watch(opts?): Promise<QueuedIterator<ObjectInfo>>

  • Watch an object store and receive updates of modifications via an iterator.

    Parameters

    • Optionalopts: Partial<{
          ignoreDeletes?: boolean;
          includeHistory?: boolean;
      }>

    Returns Promise<QueuedIterator<ObjectInfo>>

Settings

Member Visibility

On This Page

Methods