Remote Config

// access
nexus.remoteConfig

NexusRemoteConfigCopy Anchor Link

Firebase-style Remote Config: typed parameters with server-evaluated conditions (platform, version, country, percentile, custom attributes).

NexusRemoteConfigCopy Anchor Link

new NexusRemoteConfig(http: NexusHttp, id: NexusIdentity, cfg: ResolvedConfig)

Parameters

Returns NexusRemoteConfig

versionCopy Anchor Link

readonly version: number

lastFetchTimeCopy Anchor Link

readonly lastFetchTime: Date | null

setDefaults()Copy Anchor Link

setDefaults(defaults: Record<string, unknown>): void

In-app fallback values, used until/unless the server has a value.

Parameters

setAttributes()Copy Anchor Link

setAttributes(attributes: Record<string, unknown>): void

Persistent custom targeting attributes sent with every fetch.

Parameters

setAttribute()Copy Anchor Link

setAttribute(key: string, value: unknown): void

Parameters

clearAttributes()Copy Anchor Link

clearAttributes(): void

onChange()Copy Anchor Link

onChange(listener: ChangeListener): () => void

Subscribe to config changes. Returns an unsubscribe function.

Parameters

Returns () => void

fetch()Copy Anchor Link

async fetch(attributes?: Record<string, unknown>): Promise<boolean>

Fetch + activate the published template. Returns true if values changed.

Parameters

Returns Promise<boolean>

getValue()Copy Anchor Link

getValue(key: string): unknown

Parameters

Returns unknown

getString()Copy Anchor Link

getString(key: string, fallback: string = ''): string

Parameters

Returns string

getBool()Copy Anchor Link

getBool(key: string, fallback: boolean = false): boolean

Parameters

Returns boolean

getNumber()Copy Anchor Link

getNumber(key: string, fallback: number = 0): number

Parameters

Returns number

getJSON()Copy Anchor Link

getJSON<T = unknown>(key: string, fallback?: T): T

Parameters

Returns T

sourceOf()Copy Anchor Link

sourceOf(key: string): string | null

Parameters

Returns string | null

getAll()Copy Anchor Link

getAll(): Record<string, unknown>

Returns Record<string, unknown>

subscribeRealtime()Copy Anchor Link

async subscribeRealtime(realtime: NexusRealtime): Promise<void>

Re-fetch automatically when a new template is published (needs realtime).

Parameters

FunctionsCopy Anchor Link

REMOTE_CONFIG_ROOMCopy Anchor Link

const REMOTE_CONFIG_ROOM: "__remote_config"