lightyear.defineactionprops
Home > @runlightyear/lightyear > DefineActionProps
DefineActionProps interface
Signature:interface DefineActionProps
Required Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| name | string | The name of this action. | |
| run | RunFunc | The function to run when this action is triggered. | |
| title | string | The title of this action. |
Optional Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| apps? | Array<AppName> | An array of the system apps used by this action. | |
| customApps? | Array<string> | An array of the custom apps used by this action. | |
| secrets? | Array<SecretDef> | An array of the secrets on this action. Secrets are like variables, but they are stored more securely in the database and they are redacted in the console logs. Secrets are required to have a value by default. If you append a "?" to the end of the name, the secret will be optional. For example: ["requiredSecret", "optionalSecret?"] | |
| trigger? | ActionTrigger | ||
| variables? | Array<VariableDef> | An array of the variables on this action. Variables are required to have a value by default. If you append a "?" to the end of the name, the variable will be optional. For example: ["requiredVar", "optionalVar?"] |