Interface BlobDir<ContinuationT>

Directory that contains blobs and other directories within a BlobStore

interface BlobDir<ContinuationT> {
    getDir(name: string): ResultAsync<BlobDir<ContinuationT>, GetDirError>;
    query(
        continuation?: ContinuationT,
    ): ResultAsync<BlobDirEntries<ContinuationT>, DirQueryError>;
    readBlob(
        name: string,
    ): ResultAsync<Uint8Array<ArrayBufferLike>, ReadBlobError>;
    removeAll(): ResultAsync<void, StorageError>;
    removeBlob(name: string): ResultAsync<void, RemoveBlobError>;
    writeBlob(
        name: string,
        content: Uint8Array,
    ): ResultAsync<void, WriteBlobError>;
}

Type Parameters

ContinuationT

Implemented by

SimpleBlobDir

Index

Methods

getDir query readBlob removeAll removeBlob writeBlob

Methods

getDir

getDir(name: string): ResultAsync<BlobDir<ContinuationT>, GetDirError>
Get a BlobDir corresponding to the subdirectory with the specified name

Subdirectories are "created" on demand
Parameters
- name: string
Returns ResultAsync<BlobDir<ContinuationT>, GetDirError>
- Defined in packages/infinisheet-types/src/BlobStore.ts:106

query

query(
continuation?: ContinuationT,
): ResultAsync<BlobDirEntries<ContinuationT>, DirQueryError>
Query for blobs and sub-directories within this directory

The order of entries returned is undefined.

Can optionally pass a continuation token returned by the previous call to retrieve additional entries.
Parameters
- Optionalcontinuation: ContinuationT
Returns ResultAsync<BlobDirEntries<ContinuationT>, DirQueryError>
- Defined in packages/infinisheet-types/src/BlobStore.ts:114

readBlob

readBlob(name: string): ResultAsync<Uint8Array<ArrayBufferLike>, ReadBlobError>
Read the content of a blob with the specified name.

The returned content array is read only and immutable.
Parameters
- name: string
Returns ResultAsync<Uint8Array<ArrayBufferLike>, ReadBlobError>
- Defined in packages/infinisheet-types/src/BlobStore.ts:90

removeAll

removeAll(): ResultAsync<void, StorageError>
Remove this directory and it's contents, recursively

Returns ResultAsync<void, StorageError>
- Defined in packages/infinisheet-types/src/BlobStore.ts:117

removeBlob

removeBlob(name: string): ResultAsync<void, RemoveBlobError>
Remove blob with the specified name.
Parameters
- name: string
Returns ResultAsync<void, RemoveBlobError>
- Defined in packages/infinisheet-types/src/BlobStore.ts:100

writeBlob

writeBlob(name: string, content: Uint8Array): ResultAsync<void, WriteBlobError>
Write the specified content to a blob with the specified name.

Any existing blob with that name is overwritten, otherwise a new blob is created. The content array is treated as read only and must be immutable until the operation completes.
Parameters
- name: string
- content: Uint8Array
Returns ResultAsync<void, WriteBlobError>
- Defined in packages/infinisheet-types/src/BlobStore.ts:97