-
-
Notifications
You must be signed in to change notification settings - Fork 33.5k
docs: add NAPI-RS reference to the Node-API doc #59498
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Review requested:
|
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 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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
commit message should be: doc: ...
I used napi-rs many times, and it's quite ergonomic for developing Rust for Node.js.
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.
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? |
469f003
to
47b4ef1
Compare
I would second @KevinEady opinion. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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 |
PR-URL: #59516 Refs: #59498 Reviewed-By: Vladimir Morozov <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
PR-URL: #59516 Refs: #59498 Reviewed-By: Vladimir Morozov <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
PR-URL: #59516 Refs: #59498 Reviewed-By: Vladimir Morozov <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
NAPI-RS has been widely used, hope it can be mentioned in the official documentation
Blocked by nodejs/remark-preset-lint-node#633