Skip to main content

Interface: ActionReturnValue

actions/actions.types.ActionReturnValue

To be returned by Action.run

Properties​

returnValue​

• Optional returnValue: any

The value that should be returned to the caller of the command

Defined in​

actions/actions.types.ts:13

sourceSelections​

• Optional sourceSelections: SelectionWithEditor[]

A list of selections that will become the source mark for the next command. The given selections will be wrapped in UntypedTargets. This attribute is provided for convenience. Mutually exclusive with sourceTargets

Defined in​

actions/actions.types.ts:34

sourceTargets​

• Optional sourceTargets: Target[]

A list of targets that will become the source mark for the next command. Mutually exclusive with sourceSelections

Defined in​

actions/actions.types.ts:40

thatSelections​

• Optional thatSelections: SelectionWithEditor[]

A list of selections that will become the that mark for the next command. The given selections will be wrapped in UntypedTargets. This attribute is provided for convenience. Mutually exclusive with thatTargets

Defined in​

actions/actions.types.ts:21

thatTargets​

• Optional thatTargets: Target[]

A list of targets that will become the that mark for the next command. Mutually exclusive with thatSelections

Defined in​

actions/actions.types.ts:27