@push.rocks/smartbucket
Version:
A TypeScript library providing a cloud-agnostic interface for managing object storage with functionalities like bucket management, file and directory operations, and advanced features such as metadata handling and file locking.
20 lines (19 loc) • 715 B
TypeScript
import * as plugins from './plugins.js';
import { Bucket } from './classes.bucket.js';
export declare class SmartBucket {
config: plugins.tsclass.storage.IStorageDescriptor;
storageClient: plugins.s3.S3Client;
/** @deprecated Use storageClient instead */
get s3Client(): plugins.s3.S3Client;
/**
* the constructor of SmartBucket
*/
constructor(configArg: plugins.tsclass.storage.IStorageDescriptor);
createBucket(bucketNameArg: string): Promise<Bucket>;
removeBucket(bucketName: string): Promise<void>;
getBucketByName(bucketNameArg: string): Promise<Bucket>;
/**
* Check if a bucket exists
*/
bucketExists(bucketNameArg: string): Promise<boolean>;
}