Class Context

Readonlykind

Optional Readonlymessage

Readonlyvalid

Static ReadonlyUserKind

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

canonicalUnfilteredJson

• canonicalUnfilteredJson(): string | undefined

  Get the serialized canonical JSON for this context. This is not filtered for use in events.

  This method will cache the result.

  Returns string | undefined

  The serialized canonical JSON or undefined if it cannot be serialized.

getContexts

• getContexts(): [string, LDContextCommon][]

  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

• key(kind?: string): string | undefined

  Attempt to get a key for the specified kind.

  Parameters

  • Optionalkind: string

    The kind to get a key for.

  Returns string | undefined

  The key for the specified kind, or undefined.

privateAttributes

• privateAttributes(kind: string): AttributeReference[]

  Get the attribute references.

  Parameters

  • kind: string

  Returns AttributeReference[]

valueForKind

• valueForKind(reference: AttributeReference, kind?: string): any

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

  Parameters

  • reference: AttributeReference

    The reference to the value to get.

  • Optionalkind: string

    The kind of the context to get the value for.

  Returns any

  a value or undefined if one is not found.

StaticfromLDContext

• fromLDContext(context: platform.LDContext): Context

  Attempt to create a Context from an LDContext.

  Parameters

  • context: platform.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.

StatictoLDContext

• toLDContext(context: Context): platform.LDContext | undefined

  Creates a LDContext from a Context.

  Parameters

  • context: Context

    to be converted

  Returns platform.LDContext | undefined

  an LDContext if input was valid, otherwise undefined