Gecko [ thecigaretteboxes.com ]

Name	Size	Permission
doc_img	[ DIR ]	drwxr-xr-x
maintaining	[ DIR ]	drwxr-xr-x
adding-new-napi-api.md	2.55 KB	-rw-r--r--
adding-v8-fast-api.md	5.06 KB	-rw-r--r--
api-documentation.md	15.36 KB	-rw-r--r--
backporting-to-release-lines.m...	5.72 KB	-rw-r--r--
building-node-with-ninja.md	1.72 KB	-rw-r--r--
code-of-conduct.md	2.12 KB	-rw-r--r--
collaborator-guide.md	43.49 KB	-rw-r--r--
commit-queue.md	5.76 KB	-rw-r--r--
components-in-core.md	2.51 KB	-rw-r--r--
cpp-style-guide.md	12.81 KB	-rw-r--r--
diagnostic-tooling-support-tie...	8 KB	-rw-r--r--
feature-request-management.md	3.41 KB	-rw-r--r--
internal-api.md	539 B	-rw-r--r--
investigating-native-memory-le...	30.58 KB	-rw-r--r--
issues.md	3.31 KB	-rw-r--r--
node-postmortem-support.md	2.53 KB	-rw-r--r--
offboarding.md	1.13 KB	-rw-r--r--
primordials.md	21.85 KB	-rw-r--r--
pull-requests.md	24.74 KB	-rw-r--r--
releases-node-api.md	6.63 KB	-rw-r--r--
releases.md	45.29 KB	-rw-r--r--
security-model-strategy.md	2.81 KB	-rw-r--r--
security-release-process.md	10.06 KB	-rw-r--r--
security-steward-on-off-boardi...	1.02 KB	-rw-r--r--
sharing-project-news.md	1.45 KB	-rw-r--r--
static-analysis.md	798 B	-rw-r--r--
strategic-initiatives.md	3.26 KB	-rw-r--r--
streaming-to-youtube.md	4.51 KB	-rw-r--r--
suggesting-social-media-posts....	257 B	-rw-r--r--
technical-priorities.md	6.02 KB	-rw-r--r--
technical-values.md	2.79 KB	-rw-r--r--
using-internal-errors.md	5.05 KB	-rw-r--r--
using-symbols.md	2.33 KB	-rw-r--r--
writing-and-running-benchmarks...	23.5 KB	-rw-r--r--
writing-tests.md	16.05 KB	-rw-r--r--

Code Editor : adding-new-napi-api.md

# Contributing a new API to Node-API

Node-API is the next-generation ABI-stable API for native addons.
While improving the API surface is encouraged and welcomed, the following are
a set of principles and guidelines to keep in mind while adding a new
Node-API.

* A new API **must** adhere to Node-API API shape and spirit.
  * **Must** be a C API.
  * **Must** not throw exceptions.
  * **Must** return `napi_status`.
  * **Should** consume `napi_env`.
  * **Must** operate only on primitive data types, pointers to primitive
    data types or opaque handles.
  * **Must** be a necessary API and not a nice to have. Convenience APIs
    belong in node-addon-api.
  * **Must** not change the signature of an existing Node-API API or break
    ABI compatibility with other versions of Node.js.
* New API **should** be agnostic towards the underlying JavaScript VM.
* New API PRs **must** have a corresponding documentation update.
* New API PRs **must** be tagged as **node-api**.
* There **must** be at least one test case showing how to use the API.
* There **should** be at least one test case per interesting use of the API.
* There **should** be a sample provided that operates in a realistic way
  (operating how a real addon would be written).
* A new API **should** be discussed at the Node-API team meeting.
* A new API addition **must** be signed off by at least two members of
  the Node-API team.
* A new API addition **should** be simultaneously implemented in at least
  one other VM implementation of Node.js.
* A new API **must** be considered experimental for at least one minor
  version release of Node.js before it can be considered for promotion out
  of experimental.
  * Experimental APIs **must** be documented as such.
  * Experimental APIs **must** require an explicit compile-time flag
    (`#define`) to be set to opt-in.
  * Experimental APIs **must** be considered for backport.
  * Experimental status exit criteria **must** involve at least the
    following:
    * A new PR **must** be opened in `nodejs/node` to remove experimental
      status. This PR **must** be tagged as **node-api** and **semver-minor**.
    * Exiting an API from experimental **must** be signed off by the team.
    * If a backport is merited, an API **must** have a down-level
      implementation.
    * The API **should** be used by a published real-world module. Use of
      the API by a real-world published module will contribute favorably
      to the decision to take an API out of experimental status.
    * The API **must** be implemented in a Node.js implementation with an
      alternate VM.

${this.title}

Code Editor : adding-new-napi-api.md