Closed
Conversation
The library has always been compatible with Node.js 18+ through its built CommonJS and ESM outputs. This change clarifies and documents that compatibility for users who prefer Node.js over Bun. Changes: - Added complete Node.js usage guide (docs/NODEJS-USAGE.md) * Installation instructions for npm/yarn/pnpm * TypeScript configuration for Node.js * Production deployment patterns * Framework integrations (Express, Next.js) * Docker deployment guide * Troubleshooting section * Feature compatibility matrix - Added quick reference card (NODEJS-QUICKREF.md) * 30-second setup guide * Common commands and code snippets * Quick troubleshooting table - Created Node.js-specific examples * examples/nodejs-quickstart.ts - Basic usage * examples/nodejs-streaming.ts - Streaming events * examples/nodejs-express-api.ts - Express.js integration * examples/README.md - How to run examples - Updated main documentation * README.md - Feature both Node.js and Bun equally * docs/site/handbook/get-started/index.mdx - Multi-runtime instructions * Fixed misleading 'Bun required' messaging - Updated package.json * Changed engines from 'bun: >=1.0.0' to 'node: >=18.0.0' * Added 'nodejs' keyword for npm discoverability No source code changes were required - the library was already compatible! Users can now confidently use this package with Node.js 18+ or Bun. Co-authored-by: Chris Pang <chrispangg@users.noreply.github.com>
|
Cursor Agent can help with this pull request. Just |
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add comprehensive Node.js runtime support documentation and examples.
The library was already compatible with Node.js 18+ through its built CommonJS and ESM outputs, but existing documentation and
package.jsonimplied a Bun-only requirement. This PR clarifies full Node.js compatibility and provides extensive guides, examples, and updated documentation to reflect this.