Class CommandScopeImplementation

Represents an implementation of ICommandScope.

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 CommandScopeImplementation(
    _setHasChanges: (value: boolean) => void,
    _setIsPerforming?: (value: boolean) => void,
    parent?: ICommandScope,
    _getCallbacks?: () => CommandScopeCallbacks,
): CommandScopeImplementation
Parameters
- _setHasChanges: (value: boolean) => void
- Optional_setIsPerforming: (value: boolean) => void
- Optionalparent: ICommandScope
- Optional_getCallbacks: () => CommandScopeCallbacks
Returns CommandScopeImplementation
Overrides ICommandScope.constructor
- Defined in commands/CommandScopeImplementation.ts:68

Accessors

aggregatedExceptions

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

Returns readonly string[]
Overrides ICommandScope.aggregatedExceptions
- Defined in commands/CommandScopeImplementation.ts:123

aggregatedValidationFailures

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

Returns readonly ValidationResult[]
Overrides ICommandScope.aggregatedValidationFailures
- Defined in commands/CommandScopeImplementation.ts:110

exceptions

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

Returns ReadonlyMap<ICommand, string[]>
Overrides ICommandScope.exceptions
- Defined in commands/CommandScopeImplementation.ts:118

hasChanges

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

Returns boolean
Overrides ICommandScope.hasChanges
- Defined in commands/CommandScopeImplementation.ts:85

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
Overrides ICommandScope.hasExceptions
- Defined in commands/CommandScopeImplementation.ts:100

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
Overrides ICommandScope.hasValidationFailures
- Defined in commands/CommandScopeImplementation.ts:95

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
Overrides ICommandScope.isPerforming
- Defined in commands/CommandScopeImplementation.ts:90

parent

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

Returns ICommandScope | undefined
Overrides ICommandScope.parent
- Defined in commands/CommandScopeImplementation.ts:80

validationFailures

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

Returns ReadonlyMap<ICommand, ValidationResult[]>
Overrides ICommandScope.validationFailures
- Defined in commands/CommandScopeImplementation.ts:105

Methods

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
Overrides ICommandScope.addChildScope
- Defined in commands/CommandScopeImplementation.ts:131

addCommand

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

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
Overrides ICommandScope.addQuery
- Defined in commands/CommandScopeImplementation.ts:150

execute

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

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

revertChanges

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

Returns void
Overrides ICommandScope.revertChanges
- Defined in commands/CommandScopeImplementation.ts:199

Class CommandScopeImplementation

Hierarchy (View Summary)

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns CommandScopeImplementation

Accessors

aggregatedExceptions

Returns readonly string[]

aggregatedValidationFailures

Returns readonly ValidationResult[]

exceptions

Returns ReadonlyMap<ICommand, string[]>

hasChanges

Returns boolean

hasExceptions

Returns boolean

hasValidationFailures

Returns boolean

isPerforming

Returns boolean

parent

Returns ICommandScope | undefined

validationFailures

Returns ReadonlyMap<ICommand, ValidationResult[]>

Methods

addChildScope

Parameters

Returns void

addCommand

Parameters

Returns void

addQuery

Parameters

Returns void

execute

Returns Promise<CommandResults>

revertChanges

Returns void

Settings

On This Page