Class ICommandScope`Abstract`

Defines the system for tracking commands and queries in a scope. This is an abstract class that can be extended to implement custom behavior.

Hierarchy (View Summary)

ICommandScope
- CommandScopeImplementation

Index

Constructors

Accessors

aggregatedExceptions aggregatedValidationFailures exceptions hasChanges hasExceptions hasValidationFailures isPerforming parent validationFailures

Methods

addChildScope addCommand addQuery execute revertChanges

Constructors

constructor

new ICommandScope(): ICommandScope
Returns ICommandScope

Accessors

`Abstract`aggregatedExceptions

get aggregatedExceptions(): readonly string[]
Gets aggregated exception messages for this scope and all child scopes.

Returns readonly string[]
- Defined in commands/ICommandScope.ts:56

`Abstract`aggregatedValidationFailures

get aggregatedValidationFailures(): readonly ValidationResult[]
Gets aggregated validation failures for this scope and all child scopes.

Returns readonly ValidationResult[]
- Defined in commands/ICommandScope.ts:46

`Abstract`exceptions

get exceptions(): ReadonlyMap<ICommand, string[]>
Gets the exception messages per command for this scope's commands.

Returns ReadonlyMap<ICommand, string[]>
- Defined in commands/ICommandScope.ts:51

`Abstract`hasChanges

get hasChanges(): boolean
Gets whether or not there are any changes in this scope or any child scopes.

Returns boolean
- Defined in commands/ICommandScope.ts:21

`Abstract`hasExceptions

get hasExceptions(): boolean
Gets whether or not any commands in this scope or any child scopes have exceptions from the last execution.

Returns boolean
- Defined in commands/ICommandScope.ts:36

`Abstract`hasValidationFailures

get hasValidationFailures(): boolean
Gets whether or not any commands in this scope or any child scopes have validation failures from the last execution.

Returns boolean
- Defined in commands/ICommandScope.ts:31

`Abstract`isPerforming

get isPerforming(): boolean
Gets whether or not any commands or queries are currently being performed in this scope or any child scopes.

Returns boolean
- Defined in commands/ICommandScope.ts:26

`Abstract`parent

get parent(): ICommandScope | undefined
Gets the parent scope, if any.

Returns ICommandScope | undefined
- Defined in commands/ICommandScope.ts:16

`Abstract`validationFailures

get validationFailures(): ReadonlyMap<ICommand, ValidationResult[]>
Gets the validation failures per command for this scope's commands.

Returns ReadonlyMap<ICommand, ValidationResult[]>
- Defined in commands/ICommandScope.ts:41

Methods

`Abstract`addChildScope

addChildScope(scope: ICommandScope): void
Add a child scope to this scope for aggregate state tracking.
Parameters
- scope: ICommandScope
  Child scope to add.
Returns void
- Defined in commands/ICommandScope.ts:74

`Abstract`addCommand

addCommand(command: ICommand): void
Add a command for tracking in the scope.
Parameters
- command: ICommand
  Command to add.
Returns void
- Defined in commands/ICommandScope.ts:62

`Abstract`addQuery

addQuery(query: IQueryFor<unknown, unknown>): void
Add a query for tracking in the scope.
Parameters
- query: IQueryFor<unknown, unknown>
  Query to add.
Returns void
- Defined in commands/ICommandScope.ts:68

`Abstract`execute

execute(): Promise<CommandResults>
Execute all commands with changes.

Returns Promise<CommandResults>
Command results per command that was executed.
- Defined in commands/ICommandScope.ts:80

`Abstract`revertChanges

revertChanges(): void
Revert any changes for commands in scope.

Returns void
- Defined in commands/ICommandScope.ts:85