Sanity Library Reference Docs
    Preparing search index...

    Interface UploadClientConfig

    interface UploadClientConfig {
        tag?: string;
        preserveFilename?: boolean;
        filename?: string;
        timeout?: number;
        contentType?: string;
        extract?: AssetMetadataType[];
        label?: string;
        title?: string;
        description?: string;
        creditLine?: string;
        source?: { id: string; name: string; url?: string };
    }
    Index

    Properties

    tag? preserveFilename? filename? timeout? contentType? extract? label? title? description? creditLine? source?

    Properties

    tag?: string

    Optional request tag for the upload

    preserveFilename?: boolean

    Whether or not to preserve the original filename (default: true)

    filename?: string

    Filename for this file (optional)

    timeout?: number

    Milliseconds to wait before timing the request out

    contentType?: string

    Mime type of the file

    extract?: AssetMetadataType[]

    Array of metadata parts to extract from asset

    label?: string

    Optional freeform label for the asset. Generally not used.

    title?: string

    Optional title for the asset

    description?: string

    Optional description for the asset

    creditLine?: string

    The credit to person(s) and/or organization(s) required by the supplier of the asset to be used when published

    source?: { id: string; name: string; url?: string }

    Source data (when the asset is from an external service)

    Type declaration

    • id: string

      The (u)id of the asset within the source, i.e. 'i-f323r1E'

    • name: string

      The name of the source, i.e. 'unsplash'

    • Optionalurl?: string

      A url to where to find the asset, or get more info about it in the source

    Settings

    Member Visibility

    On This Page

    Properties