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

    Interface ClipFileClient

    File client interface required for persistence and clip upload. Matches the shape provided by useClient() from @hiyve/react.

    interface ClipFileClient {
        getFileURL: (
            params: { fileId: string; stream?: boolean },
        ) => Promise<string>;
        modifyFile: (
            params: { file: File; fileId: string },
        ) => Promise<void | { fileId: string }>;
        updateFilename?: (
            params: { fileId: string; newFilename: string },
        ) => Promise<unknown>;
        uploadFile: (
            params: {
                appData?: Record<string, unknown>;
                file: File;
                location: string;
                resourceType?: string;
            },
        ) => Promise<{ fileId: string }>;
    }
    Index

    Properties

    getFileURL modifyFile updateFilename? uploadFile

    Properties

    getFileURL: (params: { fileId: string; stream?: boolean }) => Promise<string>
    modifyFile: (
        params: { file: File; fileId: string },
    ) => Promise<void | { fileId: string }>
    updateFilename?: (
        params: { fileId: string; newFilename: string },
    ) => Promise<unknown>
    uploadFile: (
        params: {
            appData?: Record<string, unknown>;
            file: File;
            location: string;
            resourceType?: string;
        },
    ) => Promise<{ fileId: string }>

    Settings

    Member Visibility

    On This Page

    Properties