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)

Properties

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

Properties

Optionalbody

body?: any

Optionalcache

cache?: undefined

OptionalcacheMode

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.

OptionalfilterResponse

filterResponse?: true

Optionalheaders

headers?: Record<string, string>

OptionallastLiveEventId

lastLiveEventId?: null | string | string[]

Optionalmethod

method?: string

Optionalnext

next?: undefined

Optionalperspective

perspective?: ClientPerspective

Optionalquery

query?: any

OptionalresultSourceMap

resultSourceMap?: boolean | "withKeyArraySelector"

OptionalreturnQuery

returnQuery?: boolean

Optionalsignal

signal?: AbortSignal

Optionalstega

stega?: boolean | StegaConfig

Optionaltag

tag?: string

Optionaltimeout

timeout?: number

Optionaltoken

token?: string

OptionaluseCdn

useCdn?: boolean

Settings

Member Visibility

On This Page

Properties