@ironflow/node 0.16.0 → 0.17.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -5
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -96,7 +96,7 @@ All fields on the config object:
|
|
|
96
96
|
|-------|------|-------------|
|
|
97
97
|
| `id` | `string` | **Required.** Unique function identifier. |
|
|
98
98
|
| `name` | `string` | Display name. Defaults to `id`. |
|
|
99
|
-
| `triggers` | `Trigger[]` | **Required.** Array of event triggers. |
|
|
99
|
+
| `triggers` | `Trigger[]` | **Required.** Array of event triggers (can be empty for invoke-only functions). |
|
|
100
100
|
| `retry` | `RetryConfig` | Retry policy for failed steps. |
|
|
101
101
|
| `timeout` | `number` | Function timeout in milliseconds (default: 600000 = 10 min). |
|
|
102
102
|
| `concurrency` | `ConcurrencyConfig` | Concurrency control. |
|
|
@@ -108,6 +108,7 @@ All fields on the config object:
|
|
|
108
108
|
| `recording` | `boolean` | Enable audit recording for this function. |
|
|
109
109
|
| `recordingRetention` | `string` | Retention period for audit events (`"7d"`, `"30d"`, `"90d"`, `"forever"`). |
|
|
110
110
|
| `pauseBehavior` | `"hold" \| "release"` | Controls whether a paused run retains (`"hold"`, default) or releases (`"release"`) its concurrency lane slot. |
|
|
111
|
+
| `metadata` | `Record<string, unknown>` | Arbitrary metadata attached to the function definition. |
|
|
111
112
|
|
|
112
113
|
**Trigger** fields:
|
|
113
114
|
|
|
@@ -576,6 +577,7 @@ Workers poll the Ironflow server for jobs via REST HTTP. Use for long-running ta
|
|
|
576
577
|
| `environment` | `string` | `IRONFLOW_ENV` or `"default"` | Target environment. |
|
|
577
578
|
| `eventDefinitions` | `EventDefinitionRegistry` | -- | Registry for automatic event upcasting. |
|
|
578
579
|
| `apiKey` | `string` | `IRONFLOW_API_KEY` env | API key for authentication. |
|
|
580
|
+
| `transport` | `"polling" \| "streaming"` | `"polling"` | Worker transport mode. |
|
|
579
581
|
|
|
580
582
|
### Worker interface
|
|
581
583
|
|
|
@@ -691,10 +693,6 @@ await client.emit('order.placed', { orderId: '123' }, {
|
|
|
691
693
|
});
|
|
692
694
|
```
|
|
693
695
|
|
|
694
|
-
### trigger(eventName, data, options?)
|
|
695
|
-
|
|
696
|
-
Deprecated alias for `emit()`. Use `emit()` instead.
|
|
697
|
-
|
|
698
696
|
### getRun(runId)
|
|
699
697
|
|
|
700
698
|
Get a run by its ID.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@ironflow/node",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.17.0",
|
|
4
4
|
"description": "Node.js SDK for Ironflow event-driven backend platform - workers, serve handlers, and step execution",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./dist/index.js",
|
|
@@ -49,7 +49,7 @@
|
|
|
49
49
|
"pack:local": "pnpm build:bundle && cd dist-bundle && pnpm pack --pack-destination /tmp/ironflow-packs"
|
|
50
50
|
},
|
|
51
51
|
"dependencies": {
|
|
52
|
-
"@ironflow/core": "0.
|
|
52
|
+
"@ironflow/core": "0.17.0",
|
|
53
53
|
"zod": "^4.3.5"
|
|
54
54
|
},
|
|
55
55
|
"optionalDependencies": {
|