Interface LDClientDataSystemOptions

Configuration for the FDv2 client-side data system.

This interface is not stable, and not subject to any backwards compatibility guarantees or semantic versioning. It is in early access. If you want access to this feature please join the EAP. https://launchdarkly.com/docs/sdk/features/data-saving-mode

Hierarchy

Properties

automaticModeSwitching? connectionModes?

Properties

Optional automaticModeSwitching

automaticModeSwitching?: boolean | AutomaticModeSwitchingConfig | ManualModeSwitching

Controls how the SDK switches between connection modes.

  • true — enable all automatic switching (lifecycle + network)
  • false — disable all automatic switching; uses the platform default foreground mode
  • AutomaticModeSwitchingConfig — granular control over which platform events trigger automatic mode switches
  • ManualModeSwitching — disable automatic switching and specify the initial connection mode explicitly

Default is true for mobile SDKs, false for browser.

Optional connectionModes

connectionModes?: Partial<Record<FDv2ConnectionMode, ModeDefinition>>

Override the data source pipeline for specific connection modes.

Each key is a connection mode name ('streaming', 'polling', 'offline', 'one-shot', 'background'). The value defines the initializers and synchronizers for that mode, replacing the built-in defaults.

Only the modes you specify are overridden — unspecified modes retain their built-in definitions.

Example

connectionModes: {
  streaming: {
    initializers: [{ type: 'polling' }],
    synchronizers: [{ type: 'streaming' }],
  },
}

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc