@resistdesign/voltra
    Preparing search index...

    Type Alias CloudFileServiceDriver

    An API for a cloud file service driver.

    type CloudFileServiceDriver = {
        deleteFile: (
            file: BaseFileLocationInfo,
            baseDirectory?: string,
        ) => Promise<void>;
        getFileDownloadUrl: (
            file: BaseFileLocationInfo,
            baseDirectory?: string,
        ) => Promise<string>;
        getFileUploadUrl: (
            file: BaseFileLocationInfo,
            baseDirectory?: string,
        ) => Promise<string>;
        listFiles: (
            path?: string,
            baseDirectory?: string,
            maxNumberOfFiles?: number,
            cursor?: string,
        ) => Promise<ListFilesResult>;
    }
    Index

    Properties

    deleteFile getFileDownloadUrl getFileUploadUrl listFiles

    Properties

    deleteFile: (
        file: BaseFileLocationInfo,
        baseDirectory?: string,
    ) => Promise<void>

    Delete a file.

    Type Declaration

      • (file: BaseFileLocationInfo, baseDirectory?: string): Promise<void>

      • Parameters

        • file: BaseFileLocationInfo

          File location info.

        • OptionalbaseDirectory: string

          Optional base directory prefix.

        Returns Promise<void>

        Promise resolved once deleted.

    getFileDownloadUrl: (
        file: BaseFileLocationInfo,
        baseDirectory?: string,
    ) => Promise<string>

    Get a signed URL for downloading a file.

    Type Declaration

      • (file: BaseFileLocationInfo, baseDirectory?: string): Promise<string>

      • Parameters

        • file: BaseFileLocationInfo

          File location info.

        • OptionalbaseDirectory: string

          Optional base directory prefix.

        Returns Promise<string>

        Signed download URL.

    getFileUploadUrl: (
        file: BaseFileLocationInfo,
        baseDirectory?: string,
    ) => Promise<string>

    Get a signed URL for uploading a file.

    Type Declaration

      • (file: BaseFileLocationInfo, baseDirectory?: string): Promise<string>

      • Parameters

        • file: BaseFileLocationInfo

          File location info.

        • OptionalbaseDirectory: string

          Optional base directory prefix.

        Returns Promise<string>

        Signed upload URL.

    listFiles: (
        path?: string,
        baseDirectory?: string,
        maxNumberOfFiles?: number,
        cursor?: string,
    ) => Promise<ListFilesResult>

    List files in a directory.

    Type Declaration

      • (
            path?: string,
            baseDirectory?: string,
            maxNumberOfFiles?: number,
            cursor?: string,
        ): Promise<ListFilesResult>

      • Parameters

        • Optionalpath: string

          Optional path prefix to list within.

        • OptionalbaseDirectory: string

          Optional base directory prefix.

        • OptionalmaxNumberOfFiles: number

          Maximum number of files to return.

        • Optionalcursor: string

          Optional cursor string for pagination.

        Returns Promise<ListFilesResult>

        File list and cursor.

    Settings

    Member Visibility

    On This Page

    Properties