Interface WidgetSourceOptions

interface WidgetSourceOptions {
    analyticsSource?: AnalyticsSourceDescriptor;
    cache?: WidgetSourceCacheHints;
    freshness?: SourceFreshnessContract;
    maxClientRows?: number;
    realtime?: boolean;
    ttlMs?: number;
}

Index

Properties

analyticsSource? cache? freshness? maxClientRows? realtime? ttlMs?

Properties

`Optional` `Readonly`analyticsSource

analyticsSource?: AnalyticsSourceDescriptor

Optional warehouse/indexed descriptor used for cache identity and degradation reporting.

`Optional` `Readonly`cache

cache?: WidgetSourceCacheHints

`Optional` `Readonly`freshness

freshness?: SourceFreshnessContract

Freshness contract that permits cache reuse for realtime result widgets.

`Optional` `Readonly`maxClientRows

maxClientRows?: number

Maximum rows a client-side fallback may materialize.

Default

`Optional` `Readonly`realtime

realtime?: boolean

Set true for realtime feeds so widget result caches are disabled by default.

`Optional` `Readonly`ttlMs

ttlMs?: number

Default TTL advertised in response cache metadata.