Interface LDServerSession

A per-request evaluation scope that binds an LDServerBaseClient to a specific LDContext.

Remarks

This is idiomatic for React Server Components, where the context comes from the incoming request (headers, cookies, auth tokens) and does not change during the render.

Create a session with createLDServerSession.

Hierarchy

  • LDServerSession

Methods

allFlagsState boolVariation boolVariationDetail getContext initialized jsonVariation jsonVariationDetail numberVariation numberVariationDetail stringVariation stringVariationDetail

Methods

allFlagsState

  • Builds an object encapsulating the state of all feature flags for this session's context.

    The most common use case is bootstrapping client-side flags from a back-end service. Call toJSON() on the returned object to get the data structure used by the client SDK.

    Parameters

    • Optional options: LDFlagsStateOptions
      Optional

    Returns Promise<LDFlagsState>

boolVariation

  • Determines the boolean variation of a feature flag for this session's context.

    Parameters

    • key: string
    • defaultValue: boolean

    Returns Promise<boolean>

boolVariationDetail

  • Determines the boolean variation of a feature flag, along with evaluation details.

    Parameters

    • key: string
    • defaultValue: boolean

    Returns Promise<LDEvaluationDetailTyped<boolean>>

getContext

initialized

jsonVariation

  • Determines the JSON variation of a feature flag for this session's context.

    This version is preferred in TypeScript because it returns unknown instead of any, requiring an explicit cast before use.

    Parameters

    • key: string
    • defaultValue: unknown

    Returns Promise<unknown>

jsonVariationDetail

  • Determines the JSON variation of a feature flag, along with evaluation details.

    Parameters

    • key: string
    • defaultValue: unknown

    Returns Promise<LDEvaluationDetailTyped<unknown>>

numberVariation

  • Determines the numeric variation of a feature flag for this session's context.

    Parameters

    • key: string
    • defaultValue: number

    Returns Promise<number>

numberVariationDetail

  • Determines the numeric variation of a feature flag, along with evaluation details.

    Parameters

    • key: string
    • defaultValue: number

    Returns Promise<LDEvaluationDetailTyped<number>>

stringVariation

  • Determines the string variation of a feature flag for this session's context.

    Parameters

    • key: string
    • defaultValue: string

    Returns Promise<string>

stringVariationDetail

  • Determines the string variation of a feature flag, along with evaluation details.

    Parameters

    • key: string
    • defaultValue: string

    Returns Promise<LDEvaluationDetailTyped<string>>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc