Hiyve Components - v1.0.0
    Preparing search index...

    Interface FileClient

    interface FileClient {
        modifyFile: (options: FileModifyOptions) => Promise<void>;
        updateFileAppData?: (
            options: { appData: Record<string, unknown>; fileId: string },
        ) => Promise<void>;
        uploadFile: (options: FileUploadOptions) => Promise<FileUploadResult>;
    }
    Index

    Properties

    modifyFile updateFileAppData? uploadFile

    Properties

    modifyFile: (options: FileModifyOptions) => Promise<void>

    Modify an existing file in storage.

    Type Declaration

      • (options: FileModifyOptions): Promise<void>

      • Parameters

        Returns Promise<void>

        Promise that resolves when the file is updated

    updateFileAppData?: (
        options: { appData: Record<string, unknown>; fileId: string },
    ) => Promise<void>

    Update application-specific metadata for a file without re-uploading content.

    Type Declaration

      • (options: { appData: Record<string, unknown>; fileId: string }): Promise<void>

      • Parameters

        • options: { appData: Record<string, unknown>; fileId: string }

          The file ID and new appData object

        Returns Promise<void>

        Promise that resolves when the appData is updated

    uploadFile: (options: FileUploadOptions) => Promise<FileUploadResult>

    Upload a new file to storage.

    Type Declaration

    Settings

    Member Visibility

    On This Page

    Properties