@gensx/storage
Version:
Cloud storage, blobs, sqlite, and vector database providers/hooks for GenSX.
37 lines • 1.37 kB
TypeScript
import { Blob, BlobStorageOptions, DeleteBlobResult, ListBlobsOptions, ListBlobsResponse } from "./types.js";
/**
* Client for interacting with blob storage functionality outside of JSX context
*/
export declare class BlobClient {
private storage;
/**
* Create a new BlobClient
* @param options Optional configuration properties for the blob storage
*/
constructor(options?: BlobStorageOptions);
/**
* Get a blob
* @param key The blob key
* @returns A Blob instance for the given key
*/
getBlob<T = unknown>(key: string): Blob<T>;
/**
* List all blobs with optional filtering and pagination
* @param options Optional listing options including prefix, limit, and cursor for pagination
* @returns A Promise resolving to the list response containing keys and pagination info
*/
listBlobs(options?: ListBlobsOptions): Promise<ListBlobsResponse>;
/**
* Check if a blob exists
* @param key The blob key
* @returns A Promise resolving to a boolean indicating if the blob exists
*/
blobExists(key: string): Promise<boolean>;
/**
* Delete a blob
* @param key The blob key
* @returns A Promise resolving to the result of the delete operation
*/
deleteBlob(key: string): Promise<DeleteBlobResult>;
}
//# sourceMappingURL=blobClient.d.ts.map