Class ExceptionThrower

An action that throws an exception when executed. This can be used in rules that need to indicate an error condition.

Hierarchy (View Summary)

ExecutableAction
- ExceptionThrower

Index

Constructors

Properties

preparedEffect? compiled?

Methods

prepareEffect required invokes typedChanges toString toJS toJson checkTypes execute

Constructors

constructor

new ExceptionThrower(errorMessage: string): ExceptionThrower
Parameters
- errorMessage: string
Returns ExceptionThrower
Overrides ExecutableAction.constructor
- Defined in src/rules/executable.ts:254

Properties

`Protected` `Optional`preparedEffect

preparedEffect?: Partial<RuleEffect>

`Protected` `Optional`compiled

compiled?: Function

Methods

prepareEffect

prepareEffect(partial: Partial<RuleEffect>): this
Parameters
- partial: Partial<RuleEffect>
Returns this
Inherited from ExecutableAction.prepareEffect
- Defined in src/rules/executable.ts:44

required

required(): Set<string>
What data keys are required for this action to be evaluated?

Returns Set<string>
a set of data keys required for this action to be evaluated.
Overrides ExecutableAction.required
- Defined in src/rules/executable.ts:259

invokes

invokes(): Set<string>
What functions are invoked by this action? This information can be used for optimization, caching, or to determine which function nodes in the graph are relevant for this action.

Returns Set<string>
a set of function names invoked by this action.
Overrides ExecutableAction.invokes
- Defined in src/rules/executable.ts:263

typedChanges

typedChanges(
checker?: TypeChecker,
): Record<string, AtomicType | ArrayType | ObjectType>
What data keys will be changed when this action is executed, along with their expected types?
Parameters
- Optionalchecker: TypeChecker
Returns Record<string, AtomicType | ArrayType | ObjectType>
a record mapping data keys to their expected types.
Overrides ExecutableAction.typedChanges
- Defined in src/rules/executable.ts:267

toString

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

Returns string
Overrides ExecutableAction.toString
- Defined in src/rules/executable.ts:271

toJS

toJS(): string
Returns string
Overrides ExecutableAction.toJS
- Defined in src/rules/executable.ts:275

toJson

toJson(): Renderable
Returns Renderable
Overrides ExecutableAction.toJson
- Defined in src/rules/executable.ts:279

checkTypes

checkTypes(checker?: TypeChecker): ValidationResult
Perform type checking using the given type checker on this object.
Parameters
- Optionalchecker: TypeChecker
  the type checker to use for validating the target.
Returns ValidationResult
the result of the type check, indicating whether the target is valid and any errors if it is not.
Overrides ExecutableAction.checkTypes
- Defined in src/rules/executable.ts:286

execute

execute(context: WorkingContext): RuleEffect
Execute the required action in the given context and return the effects of the execution.
Parameters
- context: WorkingContext
  the current working context containing data and constants.
Returns RuleEffect
the effects of executing the action, including any changes or exceptions.
Overrides ExecutableAction.execute
- Defined in src/rules/executable.ts:290