@nuvix/storage/dist/src/device.d.ts

S3-compatible storage library for Nuvix BaaS platform with support for AWS S3, Wasabi, MinIO, and local storage

export interface DeviceMetadata {
    [key: string]: any;
}
export declare abstract class Device {
    /**
     * Max chunk size while transferring file from one device to another
     */
    protected transferChunkSize: number;
    /**
     * Sets the maximum number of keys returned to the response. By default, the action returns up to 1,000 key names.
     */
    protected static readonly MAX_PAGE_SIZE: number;
    /**
     * Set Transfer Chunk Size
     */
    setTransferChunkSize(chunkSize: number): void;
    /**
     * Get Transfer Chunk Size
     */
    getTransferChunkSize(): number;
    /**
     * Get Name.
     *
     * Get storage device name
     */
    abstract getName(): string;
    /**
     * Get Type.
     *
     * Get storage device type
     */
    abstract getType(): string;
    /**
     * Get Description.
     *
     * Get storage device description and purpose.
     */
    abstract getDescription(): string;
    /**
     * Get Root.
     *
     * Get storage device root path
     */
    abstract getRoot(): string;
    /**
     * Get Path.
     *
     * Each device hold a complex directory structure that is being build in this method.
     */
    abstract getPath(filename: string, prefix?: string): string;
    /**
     * Upload.
     *
     * Upload a file to desired destination in the selected disk
     * return number of chunks uploaded or 0 if it fails.
     */
    abstract upload(source: string, path: string, chunk?: number, chunks?: number, metadata?: DeviceMetadata): Promise<number>;
    /**
     * Upload Data.
     *
     * Upload file contents to desired destination in the selected disk.
     * return number of chunks uploaded or 0 if it fails.
     */
    abstract uploadData(data: string | Buffer, path: string, contentType: string, chunk?: number, chunks?: number, metadata?: DeviceMetadata): Promise<number>;
    /**
     * Abort Chunked Upload
     */
    abstract abort(path: string, extra?: string): Promise<boolean>;
    /**
     * Read file by given path.
     */
    abstract read(path: string, offset?: number, length?: number): Promise<Buffer>;
    /**
     * Transfer
     * Transfer a file from current device to destination device.
     */
    abstract transfer(path: string, destination: string, device: Device): Promise<boolean>;
    /**
     * Write file by given path.
     */
    abstract write(path: string, data: string | Buffer, contentType: string): Promise<boolean>;
    /**
     * Move file from given source to given path, return true on success and false on failure.
     */
    move(source: string, target: string): Promise<boolean>;
    /**
     * Delete file in given path return true on success and false on failure.
     */
    abstract delete(path: string, recursive?: boolean): Promise<boolean>;
    /**
     * Delete files in given path, path must be a directory. return true on success and false on failure.
     */
    abstract deletePath(path: string): Promise<boolean>;
    /**
     * Check if file exists
     */
    abstract exists(path: string): Promise<boolean>;
    /**
     * Returns given file path its size.
     */
    abstract getFileSize(path: string): Promise<number>;
    /**
     * Returns given file path its mime type.
     */
    abstract getFileMimeType(path: string): Promise<string>;
    /**
     * Returns given file path its MD5 hash value.
     */
    abstract getFileHash(path: string): Promise<string>;
    /**
     * Create a directory at the specified path.
     *
     * Returns true on success or if the directory already exists and false on error
     */
    abstract createDirectory(path: string): Promise<boolean>;
    /**
     * Get directory size in bytes.
     *
     * Return -1 on error
     */
    abstract getDirectorySize(path: string): Promise<number>;
    /**
     * Get Partition Free Space.
     *
     * Returns available space on filesystem or disk partition
     */
    abstract getPartitionFreeSpace(): Promise<number>;
    /**
     * Get Partition Total Space.
     *
     * Returns the total size of a filesystem or disk partition
     */
    abstract getPartitionTotalSpace(): Promise<number>;
    /**
     * Get all files and directories inside a directory.
     */
    abstract getFiles(dir: string, max?: number, continuationToken?: string): Promise<any[]>;
    /**
     * Get the absolute path by resolving strings like ../, .., //, /\ and so on.
     *
     * Works like the realpath function but works on files that does not exist
     */
    getAbsolutePath(path: string): string;
    protected getMimeType(filePath: string): Promise<string>;
}
//# sourceMappingURL=device.d.ts.map