Documentation
    Preparing search index...

    Interface StorageAdapterInterface

    These are the public functions that any storage adapter must expose

    interface StorageAdapterInterface {
        copy(file: FileType, destFile: FileType): Promise<any>;
        create(file: FileType, stream: Readable): Promise<FileType>;
        delete(file: FileType): Promise<Boolean>;
        download(file: FileType, path: DownloadFileMetaType): Promise<string>;
        generateImageThumbnail(file: FileType, sizes: number[]): Promise<any>;
        generateThumbnail(file: FileType, sizes: number[]): Promise<any>;
        generateVideoThumbnail(file: FileType, sizes: number[]): Promise<any>;
        getBucketStats(bucket?: string, prefix?: string): Promise<BucketStatsType>;
        getDriver(): any;
        getMetaData(filePath: FileType): Promise<FileType>;
        getReadable(filePath: FileType): Promise<Readable>;
        getUploadUrl(filePath: FileType, expiresIn?: number): Promise<any>;
        getUrl(
            file: FileType,
            expiresIn?: number,
            action?: string,
            extra?: any,
        ): Promise<any>;
        move(file: FileType, destFile: FileType): Promise<any>;
        stream(file: FileType, res: any): Promise<any>;
    }

    Implemented by

    Index

    Methods

    • Parameters

      Returns Promise<any>

    • Parameters

      Returns Promise<FileType>

    • Parameters

      Returns Promise<Boolean>

    • Parameters

      Returns Promise<any>

    • Parameters

      Returns Promise<any>

    • Parameters

      Returns Promise<any>

    • Parameters

      • Optionalbucket: string
      • Optionalprefix: string

      Returns Promise<BucketStatsType>

    • Returns any

    • Parameters

      Returns Promise<Readable>

    • Parameters

      • filePath: FileType
      • OptionalexpiresIn: number

      Returns Promise<any>

    • Parameters

      • file: FileType
      • OptionalexpiresIn: number
      • Optionalaction: string
      • Optionalextra: any

      Returns Promise<any>

    • Parameters

      Returns Promise<any>

    • Parameters

      Returns Promise<any>