Class Context

Container for a context/contexts. Because contexts come from external code they must be thoroughly validated and then formed to comply with the type system.

Hierarchy

  • Context

Constructors

constructor

Properties

context? contextForKind contexts isMulti isUser kind message? privateAttributeReferences? valid wasLegacy contextForError fromLegacyUser fromMultiKindContext fromSingleKindContext getValueFromContext userKind

Accessors

canonicalKey isMultiKind kinds kindsAndKeys legacy

Methods

getContexts key privateAttributes valueForKind fromLDContext

Constructors

Private constructor

  • Contexts should be created using the static factory method Context.fromLDContext.

    Returns Context

Properties

Private Optional context

context?: any

Private contextForKind

contextForKind: any

Private contexts

contexts: any

Private isMulti

isMulti: any

Private isUser

isUser: any

Readonly kind

kind: string

Optional Readonly message

message?: string

Private Optional privateAttributeReferences

privateAttributeReferences?: any

Readonly valid

valid: boolean

Is this a valid context. If a valid context cannot be created, then this flag will be true. The validity of a context should be tested before it is used.

Private wasLegacy

wasLegacy: any

Static Private contextForError

contextForError: any

Static Private fromLegacyUser

fromLegacyUser: any

Static Private fromMultiKindContext

fromMultiKindContext: any

Static Private fromSingleKindContext

fromSingleKindContext: any

Static Private getValueFromContext

getValueFromContext: any

Static Readonly userKind

userKind: string

Accessors

canonicalKey

  • get canonicalKey(): string

  • Get the canonical key for this context.

    Returns string

isMultiKind

  • get isMultiKind(): boolean

  • True if this is a multi-kind context.

    Returns boolean

kinds

  • get kinds(): string[]

  • Get the kinds of this context.

    Returns string[]

kindsAndKeys

  • get kindsAndKeys(): Record<string, string>

  • Get the kinds, and their keys, for this context.

    Returns Record<string, string>

legacy

  • get legacy(): boolean

  • Returns boolean

Methods

getContexts

  • Get the underlying context objects from this context.

    This method is intended to be used in event generation.

    The returned objects should not be modified.

    Returns [string, LDContextCommon][]

key

  • Attempt to get a key for the specified kind.

    Parameters

    • Optional kind: string

      The kind to get a key for.

      Optional

    Returns undefined | string

    The key for the specified kind, or undefined.

privateAttributes

  • Get the attribute references.

    Parameters

    • kind: string

    Returns AttributeReference[]

valueForKind

  • Attempt to get a value for the given context kind using the given reference.

    Parameters

    • reference: AttributeReference

      The reference to the value to get.

    • Optional kind: string

      The kind of the context to get the value for.

      Optional

    Returns any

    a value or undefined if one is not found.

Static fromLDContext

  • Attempt to create a Context from an LDContext.

    Parameters

    • context: LDContext

      The input context to create a Context from.

    Returns Context

    a Context, if the context was not valid, then the returned contexts valid property will be false.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc