flydrive/build/drivers/fs/types.d.ts

File storage library with unified API to manage files across multiple cloud storage providers like S3, GCS, R2 and so on

import { ObjectVisibility, SignedURLOptions } from '../../src/types.js';
/**
 * The options accepted by the FSDriver
 */
export type FSDriverOptions = {
    /**
     * Root location of the filesystem. The files will be
     * read and persisted to this location
     */
    location: URL | string;
    /**
     * The default visibility of all the files. The FSDriver
     * does not use visbility to implement any logic, instead
     * it returns the value as it is via the "getMetaData"
     * method
     */
    visibility: ObjectVisibility;
    /**
     * Configure a custom URL builder for creating public and
     * temporary URLs
     */
    urlBuilder?: {
        /**
         * Custom implementation for creating public URLs
         */
        generateURL?(key: string, filePath: string): Promise<string>;
        /**
         * Custom implementation for creating signed/temporary URLs
         */
        generateSignedURL?(key: string, filePath: string, options: SignedURLOptions): Promise<string>;
        /**
         * Custom implementation for creating signed/temporary URLs for uploading files
         */
        generateSignedUploadURL?(key: string, filePath: string, options: SignedURLOptions): Promise<string>;
    };
};