Sanity Library Reference Docs
    Preparing search index...

    Interface ClientStegaConfig

    -- use ClientConfig instead

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

    Hierarchy (View Summary)

    Index

    Properties

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

    Properties

    allowReconfigure?: boolean
    apiHost?: string
    apiVersion?: string
    dataset?: string
    fetch?: boolean | { cache?: undefined; next?: undefined }

    set cache and next options on client.fetch instead

    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]
    maxRetries?: number

    Number of retries for requests. Defaults to 5.

    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'
    projectId?: string
    proxy?: string
    requester?: Requester

    Don't use

    requestTagPrefix?: string

    Optional request tag prefix for all request tags

    resultSourceMap?: boolean | "withKeyArraySelector"

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

    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

    stega?: boolean | StegaConfig

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

    timeout?: number
    token?: string
    useCdn?: boolean
    true
    useProjectHostname?: boolean

    Don't use

    withCredentials?: boolean

    Settings

    Member Visibility

    On This Page

    Properties