Interface: SignalDefinition<Args, Name>
common.SignalDefinition
An interface representing a Workflow signal definition, as returned from defineSignal
Remarks
Args can be used for parameter type inference in handler functions and WorkflowHandle methods.
Name can optionally be specified with a string literal type to preserve type-level knowledge of the signal name.
Type parameters
| Name | Type |
|---|---|
Args | extends any[] = [] |
Name | extends string = string |
Properties
[argsBrand]
• [argsBrand]: Args
Virtual type brand to maintain a distinction between SignalDefinition types with different args. This field is not present at run-time.
name
• name: Name
type
• type: "signal"