Class CommandContext<T>

Container for all the data need to execute a pending action, and yield a result or error at a later time.

Type parameters

T

Hierarchy

CommandContext

Implements

CommandContextLike<T>

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new CommandContext<T>(action: CommandAction<T>, config: CommandConfig<T>, abortSignal?: Observable<T>): CommandContext<T>

- Defined in command-context.ts:45
Type parameters
- T
Parameters
- action: CommandAction<T>
- config: CommandConfig<T>
- abortSignal: Observable<T> = ...
Returns CommandContext<T>

Properties

Readonly action

action: CommandAction<T>

Readonly config

config: CommandConfig<T>

Optional error

error: any

Optional hasError

hasError: boolean

Optional result

result: T

Methods

run

run(): Promise<CommandContext<T>>

- Defined in command-context.ts:89
Stands up an observable that will execute this command's action, and save the result (or error) to be unwrapped later.

Emits immediately with the seed value when mocked is set to true.

Returns Promise<CommandContext<T>>

setError

setError(error: any): CommandContext<T>

- Defined in command-context.ts:65
Convenience to change the state of this metadata to an error.

Parameters
- error: any
Returns CommandContext<T>

setResult

setResult(value: T): CommandContext<T>

- Defined in command-context.ts:55
Convenience to change the state of this metadata to a non-error result.

Parameters
- value: T
Returns CommandContext<T>

unwrap

unwrap(): Promise<T>

- Defined in command-context.ts:77
Unboxes the current state of this command as either an emission of the run result, or an exception stream for any caught errors.

Returns Promise<T>

Generated using TypeDoc