iii-node-sdk

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Node.js SDK

Node.js SDK

The TypeScript/JavaScript SDK for connecting workers to the iii engine.
用于将工作器连接到iii引擎的TypeScript/JavaScript SDK。

Documentation

文档

Install

安装

npm install iii-sdk
npm install iii-sdk

Key Exports

主要导出项

ExportPurpose
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
导出项用途
registerWorker(url, { workerName })
连接到引擎并返回客户端
registerFunction({ id }, handler)
注册异步函数处理程序
registerTrigger({ type, function_id, config })
将触发器绑定到函数
trigger({ function_id, payload, action? })
调用函数
TriggerAction.Void()
即发即弃调用模式
TriggerAction.Enqueue({ queue })
持久化异步调用模式
Logger
结构化日志记录
withSpan
,
getTracer
,
getMeter
OpenTelemetry 工具化
createChannel()
工作器之间的二进制流传输
createStream(name, adapter)
自定义流实现
registerTriggerType(id, handler)
自定义触发器类型注册

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
  • 有关使用模式和工作示例,请查看
    iii-functions-and-triggers
  • 有关HTTP端点模式,请查看
    iii-http-endpoints
  • 如需Python SDK,请查看
    iii-python-sdk
  • 如需Rust SDK,请查看
    iii-rust-sdk