The LaunchDarkly SDK edge client object.

Hierarchy

  • default
    • LDClient

Constructors

  • Parameters

    • clientSideID: string
    • platformInfo: Info
    • options: LDOptions

    Returns LDClient

Properties

bigSegmentStatusProviderInternal: default

Intended for use by platform specific client implementations.

It is not included in the main interface because it requires the use of a platform event system. For node this would be an EventEmitter, for other platforms it would likely be an EventTarget.

emitter: EventEmitter<DefaultEventMap>

Methods

  • Parameters

    Returns void

  • Parameters

    Returns Promise<LDFlagsState>

  • Parameters

    • key: string
    • context: LDContext
    • defaultValue: boolean

    Returns Promise<boolean>

  • Parameters

    • key: string
    • context: LDContext
    • defaultValue: boolean

    Returns Promise<LDEvaluationDetailTyped<boolean>>

  • Returns void

  • Parameters

    • Optional callback: ((err, res) => void)
      Optional
        • (err, res): void
        • Parameters

          • err: null | Error
          • res: boolean

          Returns void

    Returns Promise<void>

  • Parameters

    Returns void

  • Returns boolean

  • Returns boolean

  • Parameters

    • key: string
    • context: LDContext
    • defaultValue: unknown

    Returns Promise<unknown>

  • Parameters

    • key: string
    • context: LDContext
    • defaultValue: unknown

    Returns Promise<LDEvaluationDetailTyped<unknown>>

  • Parameters

    • key: string
    • context: LDContext
    • defaultValue: number

    Returns Promise<number>

  • Parameters

    • key: string
    • context: LDContext
    • defaultValue: number

    Returns Promise<LDEvaluationDetailTyped<number>>

  • Parameters

    Returns string

  • Parameters

    • key: string
    • context: LDContext
    • defaultValue: string

    Returns Promise<string>

  • Parameters

    • key: string
    • context: LDContext
    • defaultValue: string

    Returns Promise<LDEvaluationDetailTyped<string>>

  • Parameters

    • key: string
    • context: LDContext
    • Optional data: any
      Optional
    • Optional metricValue: number
      Optional

    Returns void

  • Parameters

    Returns void

  • Parameters

    • key: string
    • context: LDContext
    • defaultValue: any
    • Optional callback: ((err, res) => void)
      Optional
        • (err, res): void
        • Parameters

          • err: any
          • res: any

          Returns void

    Returns Promise<any>

  • Parameters

    • key: string
    • context: LDContext
    • defaultValue: any
    • Optional callback: ((err, res) => void)
      Optional

    Returns Promise<LDEvaluationDetail>

  • Parameters

    Returns Promise<LDClient>

Generated using TypeDoc