Node.js SDK overview
The Node.js SDK is the package every Node.js worker depends on to talk to the Orchesty platform. It owns the HTTP transport, message envelope, persistence handshake, and the base classes you extend to write Applications, Connectors, custom nodes, and batch nodes.
Install #
npm install @orchesty/nodejs-sdk
Source #
- Repository: Orchesty/orchesty-nodejs-sdk
- License and contribution guidelines live in the repo.
Versions and runtime #
| Item | Value |
|---|---|
| Current version | 5.x |
| Minimum Node.js | 20 LTS |
| Module format | CommonJS, distributed as compiled dist/ |
| TypeScript | First-class. Types ship with the package. |
What's inside #
| Folder | What it gives you |
|---|---|
Application/ | AApplication, AWebhookApplication, WebhookSubscription, ApplicationInstall, manager and loader |
Authorization/ | ABasicApplication, AOAuth2Application, providers |
Commons/ | ACommonNode, ANode and supporting types |
Connector/ | AConnector, ACommonConnector |
Batch/ | ABatchNode |
Transport/ | RequestDto, CurlSender, HTTP method enum |
Utils/ | ProcessDto, BatchProcessDto, ResultCode, helpers |
DIContainer/ | The dependency container you configure in src/index.ts |
Logger/ | The correlated logger documented in Operations: Logging |
Per-class pages #
- AApplication
- ABasicApplication
- AOAuth2Application
- AWebhookApplication
- IWebhookApplication
- WebhookSubscription
- ApplicationInstall
- ACommonNode
- AConnector
- ABatchNode
- ProcessDto
- BatchProcessDto
- RequestDto
- FormStack, Form, Field
- FieldType
- CoreFormsEnum
- ResultCode