Type Alias LDPluginOptions

LDPluginOptions: {
    clientSideID?: string;
    context?: LDContext;
    deferInitialization?: boolean;
    options?: LDOptions;
    streaming?: boolean;
    user?: LDContext;
}

Type declaration

  • OptionalclientSideID?: string

    Indicates which LaunchDarkly project to use. Must be provided here or in a call to ldInit for the SDK to work.

  • Optionalcontext?: LDContext

    A LaunchDarkly context object. If unspecified, an anonymous context with kind: 'user' will be created and used.

  • OptionaldeferInitialization?: boolean

    Defers initialization of the LaunchDarkly client until ldInit is called explicitly.

    Default Value

    false

  • Optionaloptions?: LDOptions

    Options to pass to the underlying javascript SDK.

  • Optionalstreaming?: boolean

    Whether or not to open a streaming connection to LaunchDarkly for live flag updates.

    If this is true, the client will always attempt to maintain a streaming connection; if false, it never will. If you leave the value undefined (the default), the client will open a streaming connection for live updates to flags referenced using useLDFlag.

    Note that if streaming is provided in options, it will take precedence.

    Default Value

    undefined

  • Optionaluser?: LDContext

    Deprecated

    The user property will be removed in a future version, please update your code to use context instead.

Settings

Member Visibility