Sanity Library Reference Docs
    Preparing search index...

    Interface ClientStegaConfig

    -- use ClientConfig instead

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

    Hierarchy (View Summary)

    Index

    Properties

    allowReconfigure? apiHost? apiVersion? collaboration? context? dataset? fetch? headers? ignoreBrowserTokenWarning? ignoreWarnings? lineage? maxRetries? organizationId? perspective? projectId? proxy? requestHandler? requestTagPrefix? resource? resultSourceMap? retryDelay? stackId? stega? timeout? token? useCdn? useProjectHostname? variant? withCredentials?

    Properties

    allowReconfigure?: boolean
    apiHost?: string
    apiVersion?: string
    collaboration?: { organizationId?: string }

    Organization-scoped configuration for collaboration APIs.

    Currently this is used by collaboration.comments methods.

    context?: { organizationId?: string }

    Organization-scoped configuration for Context APIs.

    Currently this is used by context.insights methods.

    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]
    lineage?: string

    Lineage token for recursion control

    maxRetries?: number

    Number of retries for requests. Defaults to 5.

    organizationId?: string

    ID of the organization owning the blueprints stack

    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

    Route requests through an HTTP(S) proxy. Node.js only. Can be replaced on an existing client via client.config({proxy}) or client.withConfig({proxy}). For environment-driven proxying, set HTTP_PROXY/HTTPS_PROXY/NO_PROXY before the process starts.

    requestHandler?: RequestHandler

    Intercepts requests after the client has resolved their URL, headers, and transport options. The handler wraps the normal client pipeline, so errors from next are already converted to ClientError or ServerError.

    A handler supplied through withConfig() replaces the current handler. To compose handlers, read the current handler from client.config() and call it from the replacement.

    Browser asset uploads and server-sent event connections are not intercepted.

    requestTagPrefix?: string

    Optional request tag prefix for all request tags

    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'
      }
    })
    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

    stackId?: string

    ID of the blueprints stack that functions.invoke() resolves function names against. Function names are unique within a stack

    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

    variant?: ClientVariant
    withCredentials?: boolean

    Settings

    Member Visibility

    On This Page

    Properties