Sanity Library Reference Docs
    Preparing search index...

    Interface UnfilteredResponseQueryOptions

    interface UnfilteredResponseQueryOptions {
        timeout?: number;
        token?: string;
        tag?: string;
        headers?: Record<string, string>;
        method?: string;
        query?: any;
        body?: any;
        signal?: AbortSignal;
        perspective?: ClientPerspective;
        resultSourceMap?: boolean | "withKeyArraySelector";
        useCdn?: boolean;
        stega?: boolean | StegaConfig;
        cache?: undefined;
        next?: undefined;
        lastLiveEventId?: string | string[] | null;
        cacheMode?: "noStale";
        filterResponse: false;
        returnQuery?: true;
    }

    Hierarchy (View Summary)

    Index

    Properties

    timeout? token? tag? headers? method? query? body? signal? perspective? resultSourceMap? useCdn? stega? cache? next? lastLiveEventId? cacheMode? filterResponse returnQuery?

    Properties

    timeout?: number
    token?: string
    tag?: string
    headers?: Record<string, string>
    method?: string
    query?: any

    Optionalbody

    body?: any
    signal?: AbortSignal
    perspective?: ClientPerspective
    resultSourceMap?: boolean | "withKeyArraySelector"
    useCdn?: boolean
    stega?: boolean | StegaConfig
    cache?: undefined
    next?: undefined
    lastLiveEventId?: string | string[] | null
    cacheMode?: "noStale"

    When set to noStale, APICDN will not return a cached response if the content is stale. Tradeoff between latency and freshness of content.

    Only to be used with live content queries and when useCdn is true.

    filterResponse: false
    returnQuery?: true

    When filterResponse is false, returnQuery also defaults to true for backwards compatibility (on the client side, not from the content lake API). Can also explicitly be set to true.

    Settings

    Member Visibility

    On This Page

    Properties