nonbinary.computer / or1-design
OR-1 dataflow CPU sketch
fork atom
or1-design / editor / tree-sitter-dfasm / node_modules / node-addon-api / README.md
at main 95 lines 5.0 kB view raw view rendered
Orual add editor syntax highlighting for dfasm
5ba509f8
1# **node-addon-api module** 2 3[![codecov](https://codecov.io/gh/nodejs/node-addon-api/branch/main/graph/badge.svg)](https://app.codecov.io/gh/nodejs/node-addon-api/tree/main) 4 5[![NPM](https://nodei.co/npm/node-addon-api.png?downloads=true&downloadRank=true)](https://nodei.co/npm/node-addon-api/) [![NPM](https://nodei.co/npm-dl/node-addon-api.png?months=6&height=1)](https://nodei.co/npm/node-addon-api/) 6 7This module contains **header-only C++ wrapper classes** which simplify 8the use of the C based [Node-API](https://nodejs.org/dist/latest/docs/api/n-api.html) 9provided by Node.js when using C++. It provides a C++ object model 10and exception handling semantics with low overhead. 11 12- [API References](doc/README.md) 13- [Badges](#badges) 14- [Contributing](#contributing) 15- [License](#license) 16 17## API References 18 19API references are available in the [doc](doc/README.md) directory. 20 21<!-- x-release-please-start-version --> 22## Current version: 8.5.0 23<!-- x-release-please-end --> 24 25(See [CHANGELOG.md](CHANGELOG.md) for complete Changelog) 26 27node-addon-api is based on [Node-API](https://nodejs.org/api/n-api.html) and supports using different Node-API versions. 28This allows addons built with it to run with Node.js versions which support the targeted Node-API version. 29**However** the node-addon-api support model is to support only the active LTS Node.js versions. This means that 30every year there will be a new major which drops support for the Node.js LTS version which has gone out of service. 31 32The oldest Node.js version supported by the current version of node-addon-api is Node.js 18.x. 33 34## Badges 35 36The use of badges is recommended to indicate the minimum version of Node-API 37required for the module. This helps to determine which Node.js major versions are 38supported. Addon maintainers can consult the [Node-API support matrix][] to determine 39which Node.js versions provide a given Node-API version. The following badges are 40available: 41 42![Node-API v1 Badge](https://github.com/nodejs/abi-stable-node/blob/doc/assets/Node-API%20v1%20Badge.svg) 43![Node-API v2 Badge](https://github.com/nodejs/abi-stable-node/blob/doc/assets/Node-API%20v2%20Badge.svg) 44![Node-API v3 Badge](https://github.com/nodejs/abi-stable-node/blob/doc/assets/Node-API%20v3%20Badge.svg) 45![Node-API v4 Badge](https://github.com/nodejs/abi-stable-node/blob/doc/assets/Node-API%20v4%20Badge.svg) 46![Node-API v5 Badge](https://github.com/nodejs/abi-stable-node/blob/doc/assets/Node-API%20v5%20Badge.svg) 47![Node-API v6 Badge](https://github.com/nodejs/abi-stable-node/blob/doc/assets/Node-API%20v6%20Badge.svg) 48![Node-API v7 Badge](https://github.com/nodejs/abi-stable-node/blob/doc/assets/Node-API%20v7%20Badge.svg) 49![Node-API v8 Badge](https://github.com/nodejs/abi-stable-node/blob/doc/assets/Node-API%20v8%20Badge.svg) 50![Node-API v9 Badge](https://github.com/nodejs/abi-stable-node/blob/doc/assets/Node-API%20v9%20Badge.svg) 51![Node-API Experimental Version Badge](https://github.com/nodejs/abi-stable-node/blob/doc/assets/Node-API%20Experimental%20Version%20Badge.svg) 52 53## Contributing 54 55We love contributions from the community to **node-addon-api**! 56See [CONTRIBUTING.md](CONTRIBUTING.md) for more details on our philosophy around extending this module. 57 58## Team members 59 60### Active 61 62| Name | GitHub Link | 63| ------------------- | ----------------------------------------------------- | 64| Anna Henningsen | [addaleax](https://github.com/addaleax) | 65| Chengzhong Wu | [legendecas](https://github.com/legendecas) | 66| Jack Xia | [JckXia](https://github.com/JckXia) | 67| Kevin Eady | [KevinEady](https://github.com/KevinEady) | 68| Michael Dawson | [mhdawson](https://github.com/mhdawson) | 69| Nicola Del Gobbo | [NickNaso](https://github.com/NickNaso) | 70| Vladimir Morozov | [vmoroz](https://github.com/vmoroz) | 71 72<details> 73 74<summary>Emeritus</summary> 75 76### Emeritus 77 78| Name | GitHub Link | 79| ------------------- | ----------------------------------------------------- | 80| Arunesh Chandra | [aruneshchandra](https://github.com/aruneshchandra) | 81| Benjamin Byholm | [kkoopa](https://github.com/kkoopa) | 82| Gabriel Schulhof | [gabrielschulhof](https://github.com/gabrielschulhof) | 83| Hitesh Kanwathirtha | [digitalinfinity](https://github.com/digitalinfinity) | 84| Jason Ginchereau | [jasongin](https://github.com/jasongin) | 85| Jim Schlight | [jschlight](https://github.com/jschlight) | 86| Sampson Gao | [sampsongao](https://github.com/sampsongao) | 87| Taylor Woll | [boingoing](https://github.com/boingoing) | 88 89</details> 90 91## License 92 93Licensed under [MIT](./LICENSE.md) 94 95[Node-API support matrix]: https://nodejs.org/dist/latest/docs/api/n-api.html#node-api-version-matrix