Interface LDServerBaseClient

A minimal structural interface that any LaunchDarkly server SDK that can be used with createLDServerSession should satisfy.

Remarks

This interface decouples the React SDK from the concrete LDClient type in @launchdarkly/js-server-sdk-common, allowing edge SDKs and other custom server client implementations to be used with createLDServerSession.

See

https://launchdarkly.github.io/js-core/packages/shared/sdk-server/docs/interfaces/LDClient.html for more information.

Hierarchy

LDServerBaseClient

Index

Methods

allFlagsState boolVariation boolVariationDetail initialized jsonVariation jsonVariationDetail numberVariation numberVariationDetail stringVariation stringVariationDetail

Methods

allFlagsState

allFlagsState(context, options?): Promise<LDFlagsState>
Builds an object encapsulating the state of all feature flags for a given context.
Parameters
- context: LDContextStrict
- Optional options: LDFlagsStateOptions
  Optional
Returns Promise<LDFlagsState>
- Defined in packages/sdk/react/src/server/LDServerBaseClient.ts:90

boolVariation

boolVariation(key, context, defaultValue): Promise<boolean>
Determines the boolean variation of a feature flag for a context.
Parameters
- key: string
- context: LDContextStrict
- defaultValue: boolean
Returns Promise<boolean>
- Defined in packages/sdk/react/src/server/LDServerBaseClient.ts:31

boolVariationDetail

boolVariationDetail(key, context, defaultValue): Promise<LDEvaluationDetailTyped<boolean>>
Determines the boolean variation of a feature flag, along with evaluation details.
Parameters
- key: string
- context: LDContextStrict
- defaultValue: boolean
Returns Promise<LDEvaluationDetailTyped<boolean>>
- Defined in packages/sdk/react/src/server/LDServerBaseClient.ts:54

initialized

initialized(): boolean
Tests whether the client has completed initialization.

Returns boolean
True if the client has successfully initialized.
- Defined in packages/sdk/react/src/server/LDServerBaseClient.ts:26

jsonVariation

jsonVariation(key, context, defaultValue): Promise<unknown>
Determines the JSON variation of a feature flag for a context.

This version is preferred in TypeScript because it returns unknown instead of any, requiring an explicit cast before use.
Parameters
- key: string
- context: LDContextStrict
- defaultValue: unknown
Returns Promise<unknown>
- Defined in packages/sdk/react/src/server/LDServerBaseClient.ts:49

jsonVariationDetail

jsonVariationDetail(key, context, defaultValue): Promise<LDEvaluationDetailTyped<unknown>>
Determines the JSON variation of a feature flag, along with evaluation details.
Parameters
- key: string
- context: LDContextStrict
- defaultValue: unknown
Returns Promise<LDEvaluationDetailTyped<unknown>>
- Defined in packages/sdk/react/src/server/LDServerBaseClient.ts:81

numberVariation

numberVariation(key, context, defaultValue): Promise<number>
Determines the numeric variation of a feature flag for a context.
Parameters
- key: string
- context: LDContextStrict
- defaultValue: number
Returns Promise<number>
- Defined in packages/sdk/react/src/server/LDServerBaseClient.ts:36

numberVariationDetail

numberVariationDetail(key, context, defaultValue): Promise<LDEvaluationDetailTyped<number>>
Determines the numeric variation of a feature flag, along with evaluation details.
Parameters
- key: string
- context: LDContextStrict
- defaultValue: number
Returns Promise<LDEvaluationDetailTyped<number>>
- Defined in packages/sdk/react/src/server/LDServerBaseClient.ts:63

stringVariation

stringVariation(key, context, defaultValue): Promise<string>
Determines the string variation of a feature flag for a context.
Parameters
- key: string
- context: LDContextStrict
- defaultValue: string
Returns Promise<string>
- Defined in packages/sdk/react/src/server/LDServerBaseClient.ts:41

stringVariationDetail

stringVariationDetail(key, context, defaultValue): Promise<LDEvaluationDetailTyped<string>>
Determines the string variation of a feature flag, along with evaluation details.
Parameters
- key: string
- context: LDContextStrict
- defaultValue: string
Returns Promise<LDEvaluationDetailTyped<string>>
- Defined in packages/sdk/react/src/server/LDServerBaseClient.ts:72

Interface LDServerBaseClient

Remarks

See

Hierarchy

Index

Methods

Methods

allFlagsState

Parameters

context: LDContextStrict

Optional options: LDFlagsStateOptions

Returns Promise<LDFlagsState>

boolVariation

Parameters

key: string

context: LDContextStrict

defaultValue: boolean

Returns Promise<boolean>

boolVariationDetail

Parameters

key: string

context: LDContextStrict

defaultValue: boolean

Returns Promise<LDEvaluationDetailTyped<boolean>>

initialized

Returns boolean

jsonVariation

Parameters

key: string

context: LDContextStrict

defaultValue: unknown

Returns Promise<unknown>

jsonVariationDetail

Parameters

key: string

context: LDContextStrict

defaultValue: unknown

Returns Promise<LDEvaluationDetailTyped<unknown>>

numberVariation

Parameters

key: string

context: LDContextStrict

defaultValue: number

Returns Promise<number>

numberVariationDetail

Parameters

key: string

context: LDContextStrict

defaultValue: number

Returns Promise<LDEvaluationDetailTyped<number>>

stringVariation

Parameters

key: string

context: LDContextStrict

defaultValue: string

Returns Promise<string>

stringVariationDetail

Parameters

key: string

context: LDContextStrict

defaultValue: string

Returns Promise<LDEvaluationDetailTyped<string>>

Settings

Member Visibility

Theme

On This Page

`Optional` options: LDFlagsStateOptions