Sanity Library Reference Docs
    Preparing search index...

    Interface ClientConfig

    interface ClientConfig {
        projectId?: string;
        dataset?: string;
        useCdn?: boolean;
        token?: string;
        resource?: ClientConfigResource;
        perspective?: ClientPerspective;
        apiHost?: string;
        apiVersion?: string;
        proxy?: string;
        requestTagPrefix?: string;
        headers?: Record<string, string>;
        ignoreBrowserTokenWarning?: boolean;
        ignoreWarnings?: string | RegExp | (string | RegExp)[];
        withCredentials?: boolean;
        allowReconfigure?: boolean;
        timeout?: number;
        maxRetries?: number;
        retryDelay?: (attemptNumber: number) => number;
        useProjectHostname?: boolean;
        requester?: Requester;
        resultSourceMap?: boolean | "withKeyArraySelector";
        fetch?: boolean | { cache?: undefined; next?: undefined };
        stega?: boolean | StegaConfig;
        lineage?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    projectId? dataset? useCdn? token? resource? perspective? apiHost? apiVersion? proxy? requestTagPrefix? headers? ignoreBrowserTokenWarning? ignoreWarnings? withCredentials? allowReconfigure? timeout? maxRetries? retryDelay? useProjectHostname? requester? resultSourceMap? fetch? stega? lineage?

    Properties

    projectId?: string
    dataset?: string
    useCdn?: boolean
    true
    token?: string
    resource?: ClientConfigResource

    Configure the client to work with a specific Sanity resource (Media Library, Canvas, etc.)

    This allows the client to interact with resources beyond traditional project datasets. When configured, methods like fetch(), assets.upload(), and mutations will operate on the specified resource.

    createClient({
      resource: {
        type: 'media-library',
        id: 'your-media-library-id'
      }
    })
    perspective?: ClientPerspective

    What perspective to use for the client. See documentation

    As of API version v2025-02-19, the default perspective has changed from raw to published. https://www.sanity.io/changelog/676aaa9d-2da6-44fb-abe5-580f28047c10|Changelog

    'published'
    apiHost?: string
    apiVersion?: string
    proxy?: string
    requestTagPrefix?: string

    Optional request tag prefix for all request tags

    headers?: Record<string, string>

    Optional default headers to include with all requests

    request-specific headers will override any default headers with the same name.

    ignoreBrowserTokenWarning?: boolean
    ignoreWarnings?: string | RegExp | (string | RegExp)[]

    Ignore specific warning messages from the client.

    • String values perform substring matching (not exact matching) against warning messages
    • RegExp values are tested against the full warning message
    • Array values allow multiple patterns to be specified
    // Ignore warnings containing "experimental"
    ignoreWarnings: 'experimental'

    // Ignore multiple warning types
    ignoreWarnings: ['experimental', 'deprecated']

    // Use regex for exact matching
    ignoreWarnings: /^This is an experimental API version$/

    // Mix strings and regex patterns
    ignoreWarnings: ['rate limit', /^deprecated/i]
    withCredentials?: boolean
    allowReconfigure?: boolean
    timeout?: number
    maxRetries?: number

    Number of retries for requests. Defaults to 5.

    retryDelay?: (attemptNumber: number) => number

    The amount of time, in milliseconds, to wait before retrying, given an attemptNumber (starting at 0).

    Defaults to exponential back-off, starting at 100ms, doubling for each attempt, together with random jitter between 0 and 100 milliseconds. More specifically the following algorithm is used:

    Delay = 100 * 2^attemptNumber + randomNumberBetween0and100

    useProjectHostname?: boolean

    Don't use

    requester?: Requester

    Don't use

    resultSourceMap?: boolean | "withKeyArraySelector"

    Adds a resultSourceMap key to the API response, with the type ContentSourceMap

    fetch?: boolean | { cache?: undefined; next?: undefined }

    set cache and next options on client.fetch instead

    stega?: boolean | StegaConfig

    Options for how, if enabled, Content Source Maps are encoded into query results using steganography

    lineage?: string

    Lineage token for recursion control

    Settings

    Member Visibility

    On This Page

    Properties