Node.js API#

These pages are generated from the exported TypeScript declaration surfaces in crates/node, including the generated root index.d.ts.

Binding At A Glance#

This summary lists the package identity and support status for the binding.

  • Package name: nemo-flow-node

  • Runtime requirement: Node.js >=20

  • Local development path: crates/node

The Node.js binding is built with napi-rs. The package root exports the core runtime lifecycle APIs, and the package also publishes focused subpath exports for typed helpers, plugin helpers, and adaptive helpers.

Main Binding Surfaces#

These entry points are the primary APIs to use from this binding.

  • Package root: scope stack, event, tool, LLM, middleware, and subscriber APIs

  • nemo-flow-node/typed: typed wrappers and codec-aware execution helpers

  • nemo-flow-node/plugin: plugin-facing helpers and configuration types

  • nemo-flow-node/adaptive: adaptive helpers layered on top of the runtime

How To Read The Generated Pages#

The generated pages are organized around the package export map:

  • Runtime: the package root declarations from index.d.ts

  • Typed Helpers: the ./typed export

  • Plugins: the ./plugin export

  • Adaptive: the ./adaptive export

Use the generated Node.js pages for symbol-level documentation: