@launchdarkly/js-client-sdk-common - v1.35.0
    Preparing search index...

    Interface InternalDataSystemOptions

    Internal data system options that extend the public type with fields that are set by platform SDKs but not exposed to end users.

    interface InternalDataSystemOptions {
        automaticModeSwitching?:
            | boolean
            | AutomaticModeSwitchingConfig
            | ManualModeSwitching;
        backgroundConnectionMode?: FDv2ConnectionMode;
        connectionModes?: Partial<Record<FDv2ConnectionMode, ModeDefinition>>;
        foregroundConnectionMode?: FDv2ConnectionMode;
    }

    Hierarchy (View Summary)

    Index
    automaticModeSwitching? backgroundConnectionMode? connectionModes? foregroundConnectionMode?
    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.

    backgroundConnectionMode?: FDv2ConnectionMode

    The connection mode to use when the application transitions to the background. Set by platform SDKs (e.g., mobile) via platform defaults.

    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.

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

    The default foreground connection mode for this platform. Populated from platform defaults during validation.

    Settings
    Member Visibility

    On This Page
    Properties