is NAN still the name of the game

Open
#74 9 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
cpp, node.js
Domain
documentation

Research direction

Review the repository README and compare its addon guidance with the linked node-addon-examples 1_hello_world example. Determine whether NAN or N-API is the current recommended approach, then update the README to state which option users should choose.

Written by the indexing model from the issue text.

Description

Is NAN still the state of the art way to create Node.js addons? Looking at a repo like this:

https://github.com/nodejs/node-addon-examples/tree/master/1_hello_world

it looks like NAPI has overtaken NAN, or?

this info should go in the readme, telling users which one is the most recent version to use?

Dominant language
C++
Stars
2.6k
Forks
602
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from nodejs/node-addon-examples

All issues in nodejs/node-addon-examples

Similar issues

More C++ issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.