About iii-node-sdk
iii-node-sdk is a TypeScript/JavaScript SDK for connecting workers to the iii engine. It supports function and trigger registration, invocation, streaming, logging, and telemetry instrumentation.
Key features
- 01Connect workers to the iii engine
- 02Register async function handlers
- 03Bind triggers to functions
- 04Invoke functions synchronously or asynchronously
- 05Support binary and custom streams
- 06Add structured logs and OpenTelemetry
Use cases
- 01Connect a TypeScript worker to the iii engine
- 02Register handlers and trigger-based execution
- 03Invoke functions with queued or fire-and-forget modes
Install
Copy the command and run it in a terminal.
$
npx skills add https:/ / github.com/ iii-hq/ skills --skill iii-node-sdkAfter installing, type/iii-node-sdkin Claude Code to confirm it loaded.
Details
From the project READMENode.js SDK
The TypeScript/JavaScript SDK for connecting workers to the iii engine.
Documentation
Full API reference: https://iii.dev/docs/api-reference/sdk-node
Install
npm install iii-sdk
Key Exports
| Export | Purpose |
|---|---|
registerWorker(url, { workerName }) | Connect to the engine and return the client |
registerFunction({ id }, handler) | Register an async function handler |
registerTrigger({ type, function_id, config }) | Bind a trigger to a function |
trigger({ function_id, payload, action? }) | Invoke a function |
TriggerAction.Void() | Fire-and-forget invocation mode |
TriggerAction.Enqueue({ queue }) | Durable async invocation mode |
Logger | Structured logging |
withSpan, getTracer, getMeter | OpenTelemetry instrumentation |
createChannel() | Binary streaming between workers |
createStream(name, adapter) | Custom stream implementation |
registerTriggerType(id, handler) | Custom trigger type registration |
Pattern Boundaries
- For usage patterns and working examples, see
iii-functions-and-triggers - For HTTP endpoint patterns, see
iii-http-endpoints - For Python SDK, see
iii-python-sdk - For Rust SDK, see
iii-rust-sdk
Comments
Markdown supported