Interface InitializedClientConfig

interface InitializedClientConfig {
    allowReconfigure?: boolean;
    apiHost: string;
    apiVersion: string;
    cdnUrl: string;
    dataset?: string;
    fetch?: boolean | { cache?: undefined; next?: undefined };
    ignoreBrowserTokenWarning?: boolean;
    isDefaultApi: boolean;
    maxRetries?: number;
    perspective?: ClientPerspective;
    projectId?: string;
    proxy?: string;
    requester?: Requester;
    requestTagPrefix?: string;
    resultSourceMap?: boolean | "withKeyArraySelector";
    retryDelay?: (attemptNumber: number) => number;
    stega: InitializedStegaConfig;
    timeout?: number;
    token?: string;
    url: string;
    useCdn: boolean;
    useProjectHostname: boolean;
    withCredentials?: boolean;
}

Hierarchy (View Summary)

Properties

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

Properties

OptionalallowReconfigure

allowReconfigure?: boolean

Whether the client can be reconfigured after initialization

apiHost

apiHost: string

API host to use. Defaults to 'api.sanity.io'

apiVersion

apiVersion: string

API version in YYYY-MM-DD format. Required to prevent breaking changes. Use current date to get latest features.

cdnUrl

cdnUrl: string

Deprecated

Internal, don't use

Optionaldataset

dataset?: string

Dataset name to use

Optionalfetch

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

Deprecated

set cache and next options on client.fetch instead

OptionalignoreBrowserTokenWarning

ignoreBrowserTokenWarning?: boolean

Ignore warning about tokens in browser environments

isDefaultApi

isDefaultApi: boolean

Deprecated

Internal, don't use

OptionalmaxRetries

maxRetries?: number

Number of times to retry failed requests

Default Value

5

Optionalperspective

perspective?: ClientPerspective

The perspective to use when querying documents.

  • 'published': Only published documents (no drafts)
  • 'drafts': Published + draft documents (draft preferred if both exist)
  • 'raw': All documents including drafts and versions

Default Value

'raw'

OptionalprojectId

projectId?: string

Project ID to connect to

Optionalproxy

proxy?: string

HTTP/HTTPS proxy URL to use

Optionalrequester

requester?: Requester

Deprecated

Don't use

OptionalrequestTagPrefix

requestTagPrefix?: string

Optional prefix added to all request tags. Used to filter and aggregate log data in request logs.

OptionalresultSourceMap

resultSourceMap?: boolean | "withKeyArraySelector"

Whether to include Content Source Maps in API responses. Useful for visual editing and debugging.

OptionalretryDelay

retryDelay?: (attemptNumber: number) => number

Function to calculate retry delay in milliseconds. Default is exponential backoff with random jitter: delay = 100 * 2^attemptNumber + random(0,100)

stega

stega: InitializedStegaConfig

The fully initialized stega config, can be used to check if stega is enabled

Optionaltimeout

timeout?: number

Request timeout in milliseconds

Optionaltoken

token?: string

Token for authentication. Required for certain operations like mutations or accessing drafts

url

url: string

Deprecated

Internal, don't use

useCdn

useCdn: boolean

Whether to use the Sanity CDN API. Set to true to use edge caching for better performance. Set to false to always use the live API for fresh data.

Default Value

true

useProjectHostname

useProjectHostname: boolean

Deprecated

Don't use

OptionalwithCredentials

withCredentials?: boolean

Whether to send credentials with requests

Settings

Member Visibility

On This Page

Properties