Sanity Library Reference Docs
    Preparing search index...

    Interface FilteredResponseQueryOptions

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

    Hierarchy (View Summary)

    Index

    Properties

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

    Properties

    Optionalbody

    body?: any
    cache?: undefined
    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?: true
    headers?: Record<string, string>
    lastLiveEventId?: null | string | string[]
    method?: string
    next?: undefined
    perspective?: ClientPerspective
    query?: any
    resultSourceMap?: boolean | "withKeyArraySelector"
    returnQuery?: boolean
    signal?: AbortSignal
    stega?: boolean | StegaConfig
    tag?: string
    timeout?: number
    token?: string
    useCdn?: boolean

    Settings

    Member Visibility

    On This Page

    Properties