ActionDefinition
@prismatic-io/spectral › "types/ActionDefinition" › ActionDefinition
ActionDefinition is the type of the object that is passed in to action
function to
define a component action.
#
Type parameters▪ TInputs: Inputs
▪ TAllowsBranching: boolean
▪ TReturn: ActionPerformReturn‹TAllowsBranching, unknown›
#
Hierarchy- ActionDefinition
#
Index#
Properties- allowsBranching
- breakLoop
- display
- dynamicBranchInput
- examplePayload
- inputs
- perform
- staticBranchNames
- terminateExecution
#
PropertiesOptional
allowsBranching#
• allowsBranching? : TAllowsBranching
Defined in packages/spectral/src/types/ActionDefinition.ts:28
Determines whether an Action will allow Conditional Branching.
Optional
breakLoop#
• breakLoop? : undefined | false | true
Defined in packages/spectral/src/types/ActionDefinition.ts:26
Specifies whether an Action will break out of a loop.
#
display• display: ActionDisplayDefinition
Defined in packages/spectral/src/types/ActionDefinition.ts:18
Defines how the Action is displayed in the Prismatic interface.
Optional
dynamicBranchInput#
• dynamicBranchInput? : undefined | string
Defined in packages/spectral/src/types/ActionDefinition.ts:32
The Input associated with Dynamic Branching.
Optional
examplePayload#
• examplePayload? : Awaited‹ReturnType‹this["perform"]››
Defined in packages/spectral/src/types/ActionDefinition.ts:34
An example of the payload outputted by an Action
#
inputs• inputs: TInputs
Defined in packages/spectral/src/types/ActionDefinition.ts:22
InputFields to present in the Prismatic interface for configuration of this Action.
#
perform• perform: ActionPerformFunction‹TInputs, TAllowsBranching, TReturn›
Defined in packages/spectral/src/types/ActionDefinition.ts:20
Function to perform when this Action is invoked.
Optional
staticBranchNames#
• staticBranchNames? : string[]
Defined in packages/spectral/src/types/ActionDefinition.ts:30
Static Branch names associated with an Action.
Optional
terminateExecution#
• terminateExecution? : undefined | false | true
Defined in packages/spectral/src/types/ActionDefinition.ts:24
Optional attribute that specifies whether an Action will terminate execution.