Interface LDClientDataSystemOptions

Configuration for the FDv2 client-side data system.

Hierarchy

  • LDClientDataSystemOptions

Properties

automaticModeSwitching? backgroundConnectionMode? initialConnectionMode?

Properties

Optional automaticModeSwitching

automaticModeSwitching?: boolean | AutomaticModeSwitchingConfig

Controls automatic mode switching in response to platform events.

  • true — enable all automatic switching (lifecycle + network)
  • false — disable all automatic switching; the user manages modes manually
  • { lifecycle?: boolean, network?: boolean } — granular control over which platform events trigger automatic mode switches

lifecycle controls foreground/background transitions (mobile) and visibility changes (browser). network controls pause/resume of data sources when network availability changes.

Default is true for mobile SDKs, false/ignored for browser.

Optional backgroundConnectionMode

backgroundConnectionMode?: FDv2ConnectionMode

The connection mode to use when the application transitions to the background.

This is primarily used by mobile SDKs (React Native). When the application enters the background, the SDK switches to this mode. When returning to the foreground, it switches back to the foreground mode.

Set to undefined or omit to disable automatic background mode switching. Set to 'background' to use the built-in background mode (polling @ 1hr). Set to 'offline' to stop all connections in the background.

Optional initialConnectionMode

initialConnectionMode?: FDv2ConnectionMode

The initial connection mode the SDK should use.

If not specified, the platform SDK provides a default:

  • Browser: 'one-shot'
  • React Native: 'streaming'
  • Electron: 'streaming'

See FDv2ConnectionMode for the available modes.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc