Class ActionContext

Implementation of IActionContext using Immutable.js.

Implements

IActionContext

Index

Constructors

Methods

delete get getRaw getSafe has hasRaw keys merge set setDefault setRaw toJS toString ensureActionContext

Constructors

constructor

new ActionContext(data?: Record<string, any>): ActionContext
Parameters
- data: Record<string, any> = {}
Returns ActionContext
- Defined in ActionContext.ts:10

Methods

delete

delete<V>(key: IActionContextKey<V>): IActionContext
Type Parameters
- V
Parameters
- key: IActionContextKey<V>
Returns IActionContext
Implementation of IActionContext.delete
- Defined in ActionContext.ts:29

get

get<V>(key: IActionContextKey<V>): V | undefined
Type Parameters
- V
Parameters
- key: IActionContextKey<V>
Returns V | undefined
Implementation of IActionContext.get
- Defined in ActionContext.ts:33

getRaw

getRaw(key: string): any
Parameters
- key: string
Returns any
- Defined in ActionContext.ts:37

getSafe

getSafe<V>(key: IActionContextKey<V>): V
Type Parameters
- V
Parameters
- key: IActionContextKey<V>
Returns V
Implementation of IActionContext.getSafe
- Defined in ActionContext.ts:41

has

has<V>(key: IActionContextKey<V>): boolean
Type Parameters
- V
Parameters
- key: IActionContextKey<V>
Returns boolean
Implementation of IActionContext.has
- Defined in ActionContext.ts:48

hasRaw

hasRaw(key: string): boolean
Parameters
- key: string
Returns boolean
- Defined in ActionContext.ts:52

keys

keys(): IActionContextKey<any>[]
Returns IActionContextKey<any>[]
Implementation of IActionContext.keys
- Defined in ActionContext.ts:67

merge

merge(...contexts: IActionContext[]): IActionContext
Parameters
- ...contexts: IActionContext[]
Returns IActionContext
Implementation of IActionContext.merge
- Defined in ActionContext.ts:56

set

set<V>(key: IActionContextKey<V>, value: V): IActionContext
Type Parameters
- V
Parameters
- key: IActionContextKey<V>
  The key to set in the new copy
- value: V
  The value that should be assigned to the key in the new copy
Returns IActionContext
A copy of the original context, additionally mapping the key to the new value.
Implementation of IActionContext.set
- Defined in ActionContext.ts:21

setDefault

setDefault<V>(key: IActionContextKey<V>, value: V): IActionContext
Will only set the value if the key is not already set.
Type Parameters
- V
Parameters
- key: IActionContextKey<V>
- value: V
Returns IActionContext
Implementation of IActionContext.setDefault
- Defined in ActionContext.ts:17

setRaw

setRaw(key: string, value: any): IActionContext
Parameters
- key: string
- value: any
Returns IActionContext
- Defined in ActionContext.ts:25

toJS

toJS(): any
Returns any
Implementation of IActionContext.toJS
- Defined in ActionContext.ts:72

toString

toString(): string
Returns a string representation of an object.

Returns string
- Defined in ActionContext.ts:76

`Static`ensureActionContext

ensureActionContext(
maybeActionContext?: IActionContext | Record<string, any>,
): IActionContext
Convert the given object to an action context object if it is not an action context object yet. If it already is an action context object, return the object as-is.
Parameters
- OptionalmaybeActionContext: IActionContext | Record<string, any>
  An action context or record.
Returns IActionContext
An action context object.
- Defined in ActionContext.ts:90