commflow
  • English

      • Troubleshooting

      This page covers the first problems a new commflow@0.0.2 user is most likely to hit.

      Node.js Version

      The package runtime requirement is Node.js >=20.0.0.

      If Node is older, upgrade Node before using the package:

      node --version

      Cannot Import commflow

      Check the package is installed in the project where you run the example:

      npm install commflow

      If you use an ESM file, name it quick-start.mjs or set "type": "module" in your application package.json.

      If you use CommonJS, prefer dynamic import:

      const { createCommflowManifest } = await import('commflow');

      There Is No Request Client Export

      That is expected in commflow@0.0.2.

      The released API is limited to manifest metadata:

      • COMMFLOW_CHANNELS
      • createCommflowManifest()
      • manifest-related TypeScript types

      Request timeout, retry, proxy, hooks, SSE, RPC, and socket runtime clients are planned but not released yet.

      Configuration

      There is no runtime configuration surface in commflow@0.0.2 because runtime clients have not shipped yet.

      You do not need environment variables, config files, proxy settings, retry policies, or VextJS integration options to use the current manifest API.

      Where To Find The Full Docs

      Choose an entry point by goal: