FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

docs: add NAPI-RS reference to the Node-API doc by Brooooooklyn · Pull Request #59498 · nodejs/node · GitHub

/ node Public

docs: add NAPI-RS reference to the Node-API doc - #59498

Closed
Brooooooklyn wants to merge 2 commits into
nodejs:mainfrom
Brooooooklyn:add-napi-rs-to-docs
Closed

docs: add NAPI-RS reference to the Node-API doc#59498
Brooooooklyn wants to merge 2 commits into
nodejs:mainfrom
Brooooooklyn:add-napi-rs-to-docs

Conversation

Brooooooklyn commented Aug 17, 2025
edited
Loading

Copy link
Copy Markdown

NAPI-RS has been widely used, hope it can be mentioned in the official documentation

Blocked by nodejs/remark-preset-lint-node#633

Copy link
Copy Markdown
Collaborator

Review requested:

  • @nodejs/node-api

nodejs-github-bot added doc Issues and PRs related to the documentations. node-api Issues and PRs related to the Node-API. labels Aug 17, 2025

Copy link
Copy Markdown
Contributor

I am not a fan of this addition, but I am interested to see what the other team members say. Other bindings and engines are just listed on https://github.com/nodejs/abi-stable-node/blob/doc/node-api-engine-bindings.md for reference.

I feel like adding this to our Node-API documentation would possibly give users the impression that we support / back the binding, or favor one binding over the other (as there are multiple Rust bindings).

What if the implementation changes for this napi-rs binding? Even if this scenario is unlikely, we'd need to ensure that now that this documentation stays up-to-date. This adds a dependency for us to maintain / monitor in our documentation.

A quick web search for "node-api rust" would provide people with the required information to find Rust bindings, alleviating us from needing to include it in official Node.js documentation.

himself65 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

commit message should be: doc: ...

Copy link
Copy Markdown
Member

I am not a fan of this addition, but I am interested to see what the other team members say. Other bindings and engines are just listed on https://github.com/nodejs/abi-stable-node/blob/doc/node-api-engine-bindings.md for reference.

I feel like adding this to our Node-API documentation would possibly give users the impression that we support / back the binding, or favor one binding over the other (as there are multiple Rust bindings).

What if the implementation changes for this napi-rs binding? Even if this scenario is unlikely, we'd need to ensure that now that this documentation stays up-to-date. This adds a dependency for us to maintain / monitor in our documentation.

A quick web search for "node-api rust" would provide people with the required information to find Rust bindings, alleviating us from needing to include it in official Node.js documentation.

I used napi-rs many times, and it's quite ergonomic for developing Rust for Node.js.

(as there are multiple Rust bindings).

Right now, there are only two binding libraries, I think? napi-rsand neon-rs, or just use webassembly from built-in rust feature. And napi-rs is the best of them, I believe.

What if the implementation changes for this napi-rs binding? Even if this scenario is unlikely, we'd need to ensure that now that this documentation stays up-to-date. This adds a dependency for us to maintain / monitor in our documentation.

It's the same situation for TypeScript support in Node.js, right? It uses swc, which is our downstream.

Anyway, I +1 on this change, but yeah, we might need basic test cases for this?

vmoroz commented Aug 18, 2025

Copy link
Copy Markdown
Member

I would second @KevinEady opinion.
We can probably add a set of links to other language bindings for better visibility, but having a screen sized description per each 3rd party language binding seems to be a bit excessive.

legendecas left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

I think the API doc should be impartial on community packages. We should link to https://github.com/nodejs/abi-stable-node/blob/doc/node-api-engine-bindings.md instead.

Copy link
Copy Markdown
Author

I think the API doc should be impartial on community packages. We should link to https://github.com/nodejs/abi-stable-node/blob/doc/node-api-engine-bindings.md instead.

Fair enough, I'll close this since you've created a PR to link the community package links

github-project-automation Bot moved this from Need Triage to Done in Node-API Team Project Aug 18, 2025
nodejs-github-bot pushed a commit that referenced this pull request Aug 22, 2025
PR-URL: #59516
Refs: #59498
Reviewed-By: Vladimir Morozov <vmorozov@microsoft.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
targos pushed a commit that referenced this pull request Aug 25, 2025
PR-URL: #59516
Refs: #59498
Reviewed-By: Vladimir Morozov <vmorozov@microsoft.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
richardlau pushed a commit that referenced this pull request Sep 20, 2025
PR-URL: #59516
Refs: #59498
Reviewed-By: Vladimir Morozov <vmorozov@microsoft.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
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

Labels

doc Issues and PRs related to the documentations. node-api Issues and PRs related to the Node-API.

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

6 participants


Back | FazBrowse Home | New Git URL