summaryrefslogtreecommitdiff
path: root/node_modules/node-addon-api/README.md
diff options
context:
space:
mode:
author8cy <[email protected]>2020-04-03 02:48:28 -0700
committer8cy <[email protected]>2020-04-03 02:48:28 -0700
commitf9159ea2d994e14180fb02ab562f0119513e67cf (patch)
tree09d14cdf05456567156738b681379d4bccd64e5c /node_modules/node-addon-api/README.md
parent2020/04/03, 02:42, V1.2.1 (diff)
downloads5nical-f9159ea2d994e14180fb02ab562f0119513e67cf.tar.xz
s5nical-f9159ea2d994e14180fb02ab562f0119513e67cf.zip
2020/04/03, 02:47, V1.2.2
Diffstat (limited to 'node_modules/node-addon-api/README.md')
-rw-r--r--node_modules/node-addon-api/README.md203
1 files changed, 0 insertions, 203 deletions
diff --git a/node_modules/node-addon-api/README.md b/node_modules/node-addon-api/README.md
deleted file mode 100644
index 2558c7e..0000000
--- a/node_modules/node-addon-api/README.md
+++ /dev/null
@@ -1,203 +0,0 @@
-# **node-addon-api module**
-This module contains **header-only C++ wrapper classes** which simplify
-the use of the C based [N-API](https://nodejs.org/dist/latest/docs/api/n-api.html)
-provided by Node.js when using C++. It provides a C++ object model
-and exception handling semantics with low overhead.
-
-N-API is an ABI stable C interface provided by Node.js for building native
-addons. It is independent from the underlying JavaScript runtime (e.g. V8 or ChakraCore)
-and is maintained as part of Node.js itself. It is intended to insulate
-native addons from changes in the underlying JavaScript engine and allow
-modules compiled for one version to run on later versions of Node.js without
-recompilation.
-
-The `node-addon-api` module, which is not part of Node.js, preserves the benefits
-of the N-API as it consists only of inline code that depends only on the stable API
-provided by N-API. As such, modules built against one version of Node.js
-using node-addon-api should run without having to be rebuilt with newer versions
-of Node.js.
-
-It is important to remember that *other* Node.js interfaces such as
-`libuv` (included in a project via `#include <uv.h>`) are not ABI-stable across
-Node.js major versions. Thus, an addon must use N-API and/or `node-addon-api`
-exclusively and build against a version of Node.js that includes an
-implementation of N-API (meaning a version of Node.js newer than 6.14.2) in
-order to benefit from ABI stability across Node.js major versions. Node.js
-provides an [ABI stability guide][] containing a detailed explanation of ABI
-stability in general, and the N-API ABI stability guarantee in particular.
-
-As new APIs are added to N-API, node-addon-api must be updated to provide
-wrappers for those new APIs. For this reason node-addon-api provides
-methods that allow callers to obtain the underlying N-API handles so
-direct calls to N-API and the use of the objects/methods provided by
-node-addon-api can be used together. For example, in order to be able
-to use an API for which the node-addon-api does not yet provide a wrapper.
-
-APIs exposed by node-addon-api are generally used to create and
-manipulate JavaScript values. Concepts and operations generally map
-to ideas specified in the **ECMA262 Language Specification**.
-
-- **[Setup](#setup)**
-- **[API Documentation](#api)**
-- **[Examples](#examples)**
-- **[Tests](#tests)**
-- **[More resource and info about native Addons](#resources)**
-- **[Code of Conduct](CODE_OF_CONDUCT.md)**
-- **[Contributors](#contributors)**
-- **[License](#license)**
-
-## **Current version: 2.0.0**
-
-(See [CHANGELOG.md](CHANGELOG.md) for complete Changelog)
-
-[![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/)
-
-<a name="setup"></a>
-
-## Setup
- - [Installation and usage](doc/setup.md)
- - [node-gyp](doc/node-gyp.md)
- - [cmake-js](doc/cmake-js.md)
- - [Conversion tool](doc/conversion-tool.md)
- - [Checker tool](doc/checker-tool.md)
- - [Generator](doc/generator.md)
- - [Prebuild tools](doc/prebuild_tools.md)
-
-<a name="api"></a>
-
-### **API Documentation**
-
-The following is the documentation for node-addon-api.
-
- - [Basic Types](doc/basic_types.md)
- - [Array](doc/basic_types.md#array)
- - [Symbol](doc/symbol.md)
- - [String](doc/string.md)
- - [Name](doc/basic_types.md#name)
- - [Number](doc/number.md)
- - [Date](doc/date.md)
- - [BigInt](doc/bigint.md)
- - [Boolean](doc/boolean.md)
- - [Env](doc/env.md)
- - [Value](doc/value.md)
- - [CallbackInfo](doc/callbackinfo.md)
- - [Reference](doc/reference.md)
- - [External](doc/external.md)
- - [Object](doc/object.md)
- - [ObjectReference](doc/object_reference.md)
- - [PropertyDescriptor](doc/property_descriptor.md)
- - [Error Handling](doc/error_handling.md)
- - [Error](doc/error.md)
- - [TypeError](doc/type_error.md)
- - [RangeError](doc/range_error.md)
- - [Object Lifetime Management](doc/object_lifetime_management.md)
- - [HandleScope](doc/handle_scope.md)
- - [EscapableHandleScope](doc/escapable_handle_scope.md)
- - [Working with JavaScript Values](doc/working_with_javascript_values.md)
- - [Function](doc/function.md)
- - [FunctionReference](doc/function_reference.md)
- - [ObjectWrap](doc/object_wrap.md)
- - [ClassPropertyDescriptor](doc/class_property_descriptor.md)
- - [Buffer](doc/buffer.md)
- - [ArrayBuffer](doc/array_buffer.md)
- - [TypedArray](doc/typed_array.md)
- - [TypedArrayOf](doc/typed_array_of.md)
- - [DataView](doc/dataview.md)
- - [Memory Management](doc/memory_management.md)
- - [Async Operations](doc/async_operations.md)
- - [AsyncWorker](doc/async_worker.md)
- - [AsyncContext](doc/async_context.md)
- - [AsyncProgressWorker](doc/async_progress_worker.md)
- - [Thread-safe Functions](doc/threadsafe_function.md)
- - [Promises](doc/promises.md)
- - [Version management](doc/version_management.md)
-
-<a name="examples"></a>
-
-### **Examples**
-
-Are you new to **node-addon-api**? Take a look at our **[examples](https://github.com/nodejs/node-addon-examples)**
-
-- **[Hello World](https://github.com/nodejs/node-addon-examples/tree/master/1_hello_world/node-addon-api)**
-- **[Pass arguments to a function](https://github.com/nodejs/node-addon-examples/tree/master/2_function_arguments/node-addon-api)**
-- **[Callbacks](https://github.com/nodejs/node-addon-examples/tree/master/3_callbacks/node-addon-api)**
-- **[Object factory](https://github.com/nodejs/node-addon-examples/tree/master/4_object_factory/node-addon-api)**
-- **[Function factory](https://github.com/nodejs/node-addon-examples/tree/master/5_function_factory/node-addon-api)**
-- **[Wrapping C++ Object](https://github.com/nodejs/node-addon-examples/tree/master/6_object_wrap/node-addon-api)**
-- **[Factory of wrapped object](https://github.com/nodejs/node-addon-examples/tree/master/7_factory_wrap/node-addon-api)**
-- **[Passing wrapped object around](https://github.com/nodejs/node-addon-examples/tree/master/8_passing_wrapped/node-addon-api)**
-
-<a name="tests"></a>
-
-### **Tests**
-
-To run the **node-addon-api** tests do:
-
-```
-npm install
-npm test
-```
-
-To avoid testing the deprecated portions of the API run
-```
-npm install
-npm test --disable-deprecated
-```
-
-### **Debug**
-
-To run the **node-addon-api** tests with `--debug` option:
-
-```
-npm run-script dev
-```
-
-If you want faster build, you might use the following option:
-
-```
-npm run-script dev:incremental
-```
-
-Take a look and get inspired by our **[test suite](https://github.com/nodejs/node-addon-api/tree/master/test)**
-
-<a name="resources"></a>
-
-## **Contributing**
-
-We love contributions from the community to **node-addon-api**.
-See [CONTRIBUTING.md](CONTRIBUTING.md) for more details on our philosophy around extending this module.
-
-### **More resource and info about native Addons**
-- **[C++ Addons](https://nodejs.org/dist/latest/docs/api/addons.html)**
-- **[N-API](https://nodejs.org/dist/latest/docs/api/n-api.html)**
-- **[N-API - Next Generation Node API for Native Modules](https://youtu.be/-Oniup60Afs)**
-
-<a name="contributors"></a>
-
-## WG Members / Collaborators
-
-### Active
-| Name | GitHub Link |
-| ------------------- | ----------------------------------------------------- |
-| Anna Henningsen | [addaleax](https://github.com/addaleax) |
-| Gabriel Schulhof | [gabrielschulhof](https://github.com/gabrielschulhof) |
-| Hitesh Kanwathirtha | [digitalinfinity](https://github.com/digitalinfinity) |
-| Jim Schlight | [jschlight](https://github.com/jschlight) |
-| Michael Dawson | [mhdawson](https://github.com/mhdawson) |
-| Kevin Eady | [KevinEady](https://github.com/KevinEady)
-| Nicola Del Gobbo | [NickNaso](https://github.com/NickNaso) |
-
-### Emeritus
-| Name | GitHub Link |
-| ------------------- | ----------------------------------------------------- |
-| Arunesh Chandra | [aruneshchandra](https://github.com/aruneshchandra) |
-| Benjamin Byholm | [kkoopa](https://github.com/kkoopa) |
-| Jason Ginchereau | [jasongin](https://github.com/jasongin) |
-| Sampson Gao | [sampsongao](https://github.com/sampsongao) |
-| Taylor Woll | [boingoing](https://github.com/boingoing) |
-
-<a name="license"></a>
-
-Licensed under [MIT](./LICENSE.md)
-
-[ABI stability guide]: https://nodejs.org/en/docs/guides/abi-stability/