Interface LDVueClient

The LaunchDarkly client interface for Vue.

Extends the base LDClient with initialization-status and context-change subscriptions that the Vue provider and composables use to react to start() and identify().

Hierarchy

LDClient
- LDVueClient

Properties

`Readonly` logger

logger: LDLogger

Methods

addHook

addHook(hook): void
Parameters
- hook: Hook
Returns void
Inherited from LDClient.addHook
- Defined in packages/shared/sdk-client/dist/esm/api/LDClient.d.ts:31

allFlags

allFlags(): LDFlagSet
Returns LDFlagSet
Inherited from LDClient.allFlags
- Defined in packages/shared/sdk-client/dist/esm/api/LDClient.d.ts:9

boolVariation

boolVariation(key, defaultValue): boolean
Parameters
- key: string
- defaultValue: boolean
Returns boolean
Inherited from LDClient.boolVariation
- Defined in packages/shared/sdk-client/dist/esm/api/LDClient.d.ts:10

boolVariationDetail

boolVariationDetail(key, defaultValue): LDEvaluationDetailTyped<boolean>
Parameters
- key: string
- defaultValue: boolean
Returns LDEvaluationDetailTyped<boolean>
Inherited from LDClient.boolVariationDetail
- Defined in packages/shared/sdk-client/dist/esm/api/LDClient.d.ts:11

close

close(): Promise<void>
Returns Promise<void>
Inherited from LDClient.close
- Defined in packages/shared/sdk-client/dist/esm/api/LDClient.d.ts:12

flush

flush(): Promise<{
error?: Error;
result: boolean;
}>
Returns Promise<{
error?: Error;
result: boolean;
}>
Inherited from LDClient.flush
- Defined in packages/shared/sdk-client/dist/esm/api/LDClient.d.ts:13

getContext

getContext(): undefined | LDContextStrict
Returns undefined | LDContextStrict
Inherited from LDClient.getContext
- Defined in packages/shared/sdk-client/dist/esm/api/LDClient.d.ts:17

getInitializationError

getInitializationError(): undefined | Error
Returns the error that caused initialization to fail, if any. Only set when getInitializationState returns 'failed'.

Returns undefined | Error
- Defined in packages/sdk/vue/src/client/LDClient.ts:37

getInitializationState

getInitializationState(): "initializing" | "failed" | "timeout" | "complete"
Returns the initialization state of the client. Useful to determine whether the client can be used to evaluate flags on initial render.

Returns "initializing" | "failed" | "timeout" | "complete"
- Defined in packages/sdk/vue/src/client/LDClient.ts:31

isReady

isReady(): boolean
Returns whether the client is ready to evaluate flags. True once initialization has completed (successfully or not), or when bootstrap data was provided.

Returns boolean
- Defined in packages/sdk/vue/src/client/LDClient.ts:61

jsonVariation

jsonVariation(key, defaultValue): unknown
Parameters
- key: string
- defaultValue: unknown
Returns unknown
Inherited from LDClient.jsonVariation
- Defined in packages/shared/sdk-client/dist/esm/api/LDClient.d.ts:19

jsonVariationDetail

jsonVariationDetail(key, defaultValue): LDEvaluationDetailTyped<unknown>
Parameters
- key: string
- defaultValue: unknown
Returns LDEvaluationDetailTyped<unknown>
Inherited from LDClient.jsonVariationDetail
- Defined in packages/shared/sdk-client/dist/esm/api/LDClient.d.ts:20

numberVariation

numberVariation(key, defaultValue): number
Parameters
- key: string
- defaultValue: number
Returns number
Inherited from LDClient.numberVariation
- Defined in packages/shared/sdk-client/dist/esm/api/LDClient.d.ts:22

numberVariationDetail

numberVariationDetail(key, defaultValue): LDEvaluationDetailTyped<number>
Parameters
- key: string
- defaultValue: number
Returns LDEvaluationDetailTyped<number>
Inherited from LDClient.numberVariationDetail
- Defined in packages/shared/sdk-client/dist/esm/api/LDClient.d.ts:23

off

off(key, callback): void
Parameters
- key: string
- callback: ((...args) => void)
  - - (...args): void
    - Parameters
      
      Rest ...args: any[]
      Rest
      
      Returns void
Returns void
Inherited from LDClient.off
- Defined in packages/shared/sdk-client/dist/esm/api/LDClient.d.ts:24

on

on(key, callback): void
Parameters
- key: string
- callback: ((...args) => void)
  - - (...args): void
    - Parameters
      
      Rest ...args: any[]
      Rest
      
      Returns void
Returns void
Inherited from LDClient.on
- Defined in packages/shared/sdk-client/dist/esm/api/LDClient.d.ts:25

onContextChange

onContextChange(callback): (() => void)
Subscribes to context changes triggered by identify(). The callback is invoked after each successful identify() call (and once after a successful start()) with the resolved context.
Parameters
- callback: ((context) => void)
  - - (context): void
    - Parameters
      
      context: LDContextStrict
      
      Returns void
Returns (() => void)
An unsubscribe function.
- - (): void
  - Subscribes to context changes triggered by identify(). The callback is invoked after each successful identify() call (and once after a successful start()) with the resolved context.
    
    Returns void
    An unsubscribe function.
- Defined in packages/sdk/vue/src/client/LDClient.ts:45

onInitializationStatusChange

onInitializationStatusChange(callback): (() => void)
Subscribes to initialization status changes. The callback fires when start() resolves. If the client has already resolved, the callback is invoked immediately with the cached result.
Parameters
- callback: ((result) => void)
  - - (result): void
    - Parameters
      
      result: LDWaitForInitializationResult
      
      Returns void
Returns (() => void)
An unsubscribe function.
- - (): void
  - Subscribes to initialization status changes. The callback fires when start() resolves. If the client has already resolved, the callback is invoked immediately with the cached result.
    
    Returns void
    An unsubscribe function.
- Defined in packages/sdk/vue/src/client/LDClient.ts:53

setConnectionMode

setConnectionMode(mode?): void
Sets the connection mode for the SDK's data system.

When set, this mode is used exclusively, overriding all automatic mode selection (including setStreaming). The setStreaming state is not modified -- setConnectionMode acts as a higher-priority override.

Pass undefined (or call with no arguments) to clear the override and return to automatic mode selection.

This method requires the FDv2 data system (dataSystem option). If FDv2 is not enabled, the call logs a warning and has no effect.

This method 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
Parameters
- Optional mode: FDv2ConnectionMode
  
  The connection mode to use, or undefined to clear the override.
  
  Optional
Returns void
Inherited from LDClient.setConnectionMode
- Defined in packages/sdk/browser/dist/index.d.ts:62

setStreaming

setStreaming(streaming?): void
Specifies 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 if you subscribe to "change" or "change:flag-key" events (see LDClient.on).

This can also be set as the streaming property of LDOptions.
Parameters
- Optional streaming: boolean
  Optional
Returns void
Inherited from LDClient.setStreaming
- Defined in packages/sdk/browser/dist/index.d.ts:72

start

start(options?): Promise<LDWaitForInitializationResult>
Starts the client and returns a promise that resolves to the initialization result.

The promise will resolve to a LDWaitForInitializationResult object containing the status of the waitForInitialization operation.
Parameters
- Optional options: LDStartOptions
  
  Optional configuration. Please see LDStartOptions.
  
  Optional
Returns Promise<LDWaitForInitializationResult>
Inherited from LDClient.start
- Defined in packages/sdk/browser/dist/index.d.ts:139

stringVariation

stringVariation(key, defaultValue): string
Parameters
- key: string
- defaultValue: string
Returns string
Inherited from LDClient.stringVariation
- Defined in packages/shared/sdk-client/dist/esm/api/LDClient.d.ts:26

stringVariationDetail

stringVariationDetail(key, defaultValue): LDEvaluationDetailTyped<string>
Parameters
- key: string
- defaultValue: string
Returns LDEvaluationDetailTyped<string>
Inherited from LDClient.stringVariationDetail
- Defined in packages/shared/sdk-client/dist/esm/api/LDClient.d.ts:27

track

track(key, data?, metricValue?): void
Parameters
- key: string
- Optional data: any
  Optional
- Optional metricValue: number
  Optional
Returns void
Inherited from LDClient.track
- Defined in packages/shared/sdk-client/dist/esm/api/LDClient.d.ts:28

variation

variation(key, defaultValue?): any
Parameters
- key: string
- Optional defaultValue: any
  Optional
Returns any
Inherited from LDClient.variation
- Defined in packages/shared/sdk-client/dist/esm/api/LDClient.d.ts:29

variationDetail

variationDetail(key, defaultValue?): LDEvaluationDetail
Parameters
- key: string
- Optional defaultValue: any
  Optional
Returns LDEvaluationDetail
Inherited from LDClient.variationDetail
- Defined in packages/shared/sdk-client/dist/esm/api/LDClient.d.ts:30

waitForInitialization

waitForInitialization(options?): Promise<LDWaitForInitializationResult>
Parameters
- Optional options: LDWaitForInitializationOptions
  Optional
Returns Promise<LDWaitForInitializationResult>
Inherited from LDClient.waitForInitialization
- Defined in packages/shared/sdk-client/dist/esm/api/LDClient.d.ts:32

Interface LDVueClient

Hierarchy

Index

Properties

Methods

Properties

Readonly logger

Methods

addHook

Parameters

hook: Hook

Returns void

allFlags

Returns LDFlagSet

boolVariation

Parameters

key: string

defaultValue: boolean

Returns boolean

boolVariationDetail

Parameters

key: string

defaultValue: boolean

Returns LDEvaluationDetailTyped<boolean>

close

Returns Promise<void>

flush

Returns Promise<{ error?: Error; result: boolean; }>

getContext

Returns undefined | LDContextStrict

getInitializationError

Returns undefined | Error

getInitializationState

Returns "initializing" | "failed" | "timeout" | "complete"

isReady

Returns boolean

jsonVariation

Parameters

key: string

defaultValue: unknown

Returns unknown

jsonVariationDetail

Parameters

key: string

defaultValue: unknown

Returns LDEvaluationDetailTyped<unknown>

numberVariation

Parameters

key: string

defaultValue: number

Returns number

numberVariationDetail

Parameters

key: string

defaultValue: number

Returns LDEvaluationDetailTyped<number>

off

Parameters

key: string

callback: ((...args) => void)

Parameters

Rest ...args: any[]

Returns void

Returns void

on

Parameters

key: string

callback: ((...args) => void)

Parameters

Rest ...args: any[]

Returns void

Returns void

onContextChange

Parameters

callback: ((context) => void)

Parameters

context: LDContextStrict

Returns void

Returns (() => void)

Returns void

`Readonly` logger

Returns Promise<{
error?: Error;
result: boolean;
}>

`Rest` ...args: any[]

`Rest` ...args: any[]

`Optional` mode: FDv2ConnectionMode

`Optional` streaming: boolean

`Optional` options: LDStartOptions

`Optional` data: any

`Optional` metricValue: number

`Optional` defaultValue: any

`Optional` defaultValue: any

`Optional` options: LDWaitForInitializationOptions