Sporades SDK API
    Preparing search index...

    Type Alias FilesApi

    Browser file API.

    Uploads hide URL negotiation and byte transfer details. Passing an array is a convenience that uploads files sequentially and returns metadata in order.

    type FilesApi = {
        delete(fileReference: string): Promise<FileMetadata>;
        download(fileReference: string): Promise<Blob>;
        publicUrl(
            fileReference: string,
            options?: PublicUrlOptions,
        ): Promise<PublicFileUrl>;
        revokePublicUrl(publicUrlId: string): Promise<PublicFileUrl>;
        upload(file: Blob | File, options?: UploadOptions): Promise<FileMetadata>;
        upload(
            files: (Blob | File)[],
            options?: UploadOptions,
        ): Promise<FileMetadata[]>;
        url(fileReference: string): Promise<string>;
    }
    Index
    delete download publicUrl revokePublicUrl upload url

    • Parameters

      • fileReference: string

      Returns Promise<Blob>

    • Parameters

      • fileReference: string

      Returns Promise<string>

    Settings
    Member Visibility

    On This Page
    Methods