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

`Private` constructor

new Context(valid, kind, message?): Context
Contexts should be created using the static factory method Context.fromLDContext.
Parameters
- valid: boolean
- kind: string
  
  The kind of the context.
  
  The factory methods are static functions within the class because they access private implementation details, so they cannot be free functions.
- Optional message: string
  Optional
Returns Context
- Defined in packages/shared/common/src/Context.ts:195

Properties

`Private` `Optional` _cachedCanonicalJson

_cachedCanonicalJson?: string

`Private` `Optional` _context

_context?: LDContextCommon

`Private` _contexts

_contexts: Record<string, LDContextCommon> = {}

`Private` _isMulti

_isMulti: boolean = false

`Private` _isUser

_isUser: boolean = false

`Private` `Optional` _privateAttributeReferences

_privateAttributeReferences?: Record<string, AttributeReference[]>

`Private` _wasLegacy

_wasLegacy: boolean = false

`Readonly` kind

kind: string

`Optional` `Readonly` message

message?: string

`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.

`Static` `Readonly` UserKind

UserKind: string = DEFAULT_KIND

Accessors

canonicalKey

get canonicalKey(): string
Get the canonical key for this context.

Returns string
- Defined in packages/shared/common/src/Context.ts:406

isMultiKind

get isMultiKind(): boolean
True if this is a multi-kind context.

Returns boolean
- Defined in packages/shared/common/src/Context.ts:399

kinds

get kinds(): string[]
Get the kinds of this context.

Returns string[]
- Defined in packages/shared/common/src/Context.ts:422

kindsAndKeys

get kindsAndKeys(): Record<string, string>
Get the kinds, and their keys, for this context.

Returns Record<string, string>
- Defined in packages/shared/common/src/Context.ts:432

legacy

get legacy(): boolean
Returns boolean
- Defined in packages/shared/common/src/Context.ts:468

Methods

`Private` _contextForKind

_contextForKind(kind): undefined | LDContextCommon
Parameters
- kind: string
Returns undefined | LDContextCommon
- Defined in packages/shared/common/src/Context.ts:219

canonicalUnfilteredJson

canonicalUnfilteredJson(): undefined | string
Get the serialized canonical JSON for this context. This is not filtered for use in events.

This method will cache the result.

Returns undefined | string
The serialized canonical JSON or undefined if it cannot be serialized.
- Defined in packages/shared/common/src/Context.ts:479

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][]
- Defined in packages/shared/common/src/Context.ts:461

key

key(kind?): undefined | string
Attempt to get a key for the specified kind.
Parameters
- kind: string = DEFAULT_KIND
  
  The kind to get a key for.
Returns undefined | string
The key for the specified kind, or undefined.
- Defined in packages/shared/common/src/Context.ts:392

privateAttributes

privateAttributes(kind): AttributeReference[]
Get the attribute references.
Parameters
- kind: string
Returns AttributeReference[]
- Defined in packages/shared/common/src/Context.ts:450

valueForKind

valueForKind(reference, kind?): 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.
- kind: string = DEFAULT_KIND
  
  The kind of the context to get the value for.
Returns any
a value or undefined if one is not found.
- Defined in packages/shared/common/src/Context.ts:380

`Static` `Private` _contextForError

_contextForError(kind, message): Context
Parameters
- kind: string
- message: string
Returns Context
- Defined in packages/shared/common/src/Context.ts:201

`Static` `Private` _fromLegacyUser

_fromLegacyUser(context): Context
Parameters
- context: LDUser
Returns Context
- Defined in packages/shared/common/src/Context.ts:310

`Static` `Private` _fromMultiKindContext

_fromMultiKindContext(context): Context
Parameters
- context: LDMultiKindContext
Returns Context
- Defined in packages/shared/common/src/Context.ts:229

`Static` `Private` _fromSingleKindContext

_fromSingleKindContext(context): Context
Parameters
- context: LDSingleKindContext
Returns Context
- Defined in packages/shared/common/src/Context.ts:285

`Static` `Private` _getValueFromContext

_getValueFromContext(reference, context?): any
Parameters
- reference: AttributeReference
- Optional context: LDContextCommon
  Optional
Returns any
- Defined in packages/shared/common/src/Context.ts:205

`Static` fromLDContext

fromLDContext(context): Context
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.
- Defined in packages/shared/common/src/Context.ts:332

`Static` toLDContext

toLDContext(context): undefined | LDContext
Creates a LDContext from a Context.
Parameters
- context: Context
  
  to be converted
Returns undefined | LDContext
an LDContext if input was valid, otherwise undefined
- Defined in packages/shared/common/src/Context.ts:354

Class Context

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

Private constructor

Parameters

valid: boolean

kind: string

Optional message: string

Returns Context

Properties

Private Optional _cachedCanonicalJson

Private Optional _context

Private _contexts

Private _isMulti

Private _isUser

Private Optional _privateAttributeReferences

Private _wasLegacy

Readonly kind

Optional Readonly message

Readonly valid

Static Readonly UserKind

Accessors

canonicalKey

Returns string

isMultiKind

Returns boolean

kinds

Returns string[]

kindsAndKeys

Returns Record<string, string>

legacy

Returns boolean

Methods

Private _contextForKind

Parameters

kind: string

Returns undefined | LDContextCommon

canonicalUnfilteredJson

Returns undefined | string

getContexts

Returns [string, LDContextCommon][]

key

Parameters

kind: string = DEFAULT_KIND

Returns undefined | string

privateAttributes

Parameters

kind: string

Returns AttributeReference[]

valueForKind

Parameters

reference: AttributeReference

kind: string = DEFAULT_KIND

Returns any

Static Private _contextForError

Parameters

kind: string

message: string

Returns Context

Static Private _fromLegacyUser

Parameters

context: LDUser

Returns Context

Static Private _fromMultiKindContext

Parameters

context: LDMultiKindContext

Returns Context

Static Private _fromSingleKindContext

Parameters

context: LDSingleKindContext

Returns Context

Static Private _getValueFromContext

Parameters

reference: AttributeReference

Optional context: LDContextCommon

`Private` constructor

`Optional` message: string

`Private` `Optional` _cachedCanonicalJson

`Private` `Optional` _context

`Private` _contexts

`Private` _isMulti

`Private` _isUser

`Private` `Optional` _privateAttributeReferences

`Private` _wasLegacy

`Readonly` kind

`Optional` `Readonly` message

`Readonly` valid

`Static` `Readonly` UserKind

`Private` _contextForKind

`Static` `Private` _contextForError

`Static` `Private` _fromLegacyUser

`Static` `Private` _fromMultiKindContext

`Static` `Private` _fromSingleKindContext

`Static` `Private` _getValueFromContext

`Optional` context: LDContextCommon

`Static` fromLDContext

`Static` toLDContext