Class: Trigger
Defined in: packages/client/src/core/trigger/index.ts:7
The Trigger class dynamically hydrates a function from a string. This allows for declarative, data-driven logic to be executed at runtime.
Extends
Trigger
Constructors
Constructor
new Trigger(model, classObj?): Trigger;
Defined in: packages/client/src/core/trigger/index.ts:19
Parameters
| Parameter | Type |
|---|---|
model | TriggerModel |
classObj? | Class |
Returns
Trigger
Overrides
Trigger_.constructor
Properties
| Property | Modifier | Type | Description | Overrides | Defined in |
|---|---|---|---|---|---|
classObj | readonly | Class | A reference to the parent Class instance. | Trigger_.classObj | packages/client/src/core/trigger/index.ts:14 |
model | readonly | TriggerModel | The declarative model for the trigger. | Trigger_.model | packages/client/src/core/trigger/index.ts:9 |
name | readonly | string | - | Trigger_.name | packages/client/src/core/trigger/index.ts:10 |
order | readonly | "before" | "after" | - | Trigger_.order | packages/client/src/core/trigger/index.ts:11 |
run | readonly | TriggerRunFunction | The dynamically hydrated function that executes the trigger logic. | Trigger_.run | packages/client/src/core/trigger/index.ts:17 |
Methods
execute()
execute(document): Promise<Document>;
Defined in: packages/client/src/core/trigger/index.ts:67
Executes the hydrated run function with the necessary context. The method is now asynchronous by default.
Parameters
| Parameter | Type | Description |
|---|---|---|
document | Document | The document to be processed by the trigger. |
Returns
Promise<Document>
The updated document returned by the trigger logic as a Promise.
Overrides
Trigger_.execute
executeLimited()
executeLimited(document): Promise<Document>;
Defined in: packages/client/src/core/trigger/index.ts:89
Executes the hydrated run function without providing class or stack context. This is useful for testing or previews where cross-document behaviors are not desired.
Parameters
| Parameter | Type | Description |
|---|---|---|
document | Document | The document to be processed by the trigger. |
Returns
Promise<Document>
The updated document returned by the trigger logic as a Promise.
Overrides
Trigger_.executeLimited