Node.js C++ Addon 示例项目教程

Node.js C++ Addon 示例项目教程

node-addon-examples Node.js C++ addon examples from http://nodejs.org/docs/latest/api/addons.html 项目地址: https://gitcode.com/gh_mirrors/no/node-addon-examples

1. 项目的目录结构及介绍

Node.js C++ Addon 示例项目的目录结构如下：

REPO_ROOT
├── test_all.js
├── package.json
├── README.md
└── src
    ├── 1-getting-started
    │   ├── example1
    │   │   ├── nan
    │   │   ├── node-addon-api
    │   │   └── napi
    │   ├── example2
    │   └── example3
    ├── 2-js-to-native-conversion
    ├── 3-context-awareness
    ├── 4-references-and-handle-scope
    ├── 5-async-work
    ├── 6-threadsafe-function
    ├── 7-events
    └── 8-tooling

目录结构介绍

• REPO_ROOT: 项目根目录，包含项目的核心文件和配置文件。
• test_all.js: 用于测试所有示例的脚本文件。
• package.json: 项目的配置文件，包含依赖项和脚本命令。
• README.md: 项目的说明文档。
• src: 包含所有示例代码的目录。
  • 1-getting-started: 入门示例，包含多个子示例。
    • example1: 第一个示例，包含不同API的实现（nan, node-addon-api, napi）。
    • example2: 第二个示例。
    • example3: 第三个示例。
  • 2-js-to-native-conversion: JavaScript 到原生代码转换的示例。
  • 3-context-awareness: 上下文感知示例。
  • 4-references-and-handle-scope: 引用和句柄作用域示例。
  • 5-async-work: 异步工作示例。
  • 6-threadsafe-function: 线程安全函数示例。
  • 7-events: 事件示例。
  • 8-tooling: 工具示例。

2. 项目的启动文件介绍

项目的启动文件是 test_all.js，它用于测试所有示例。你可以通过运行以下命令来启动测试：

node test_all.js

该脚本会遍历所有示例，并执行相应的测试代码。

3. 项目的配置文件介绍

项目的配置文件是 package.json，它包含了项目的依赖项、脚本命令和其他配置信息。以下是 package.json 的部分内容：

{
  "name": "node-addon-examples",
  "version": "1.0.0",
  "description": "Node.js C++ addon examples",
  "main": "test_all.js",
  "scripts": {
    "test": "node test_all.js"
  },
  "dependencies": {
    "nan": "^2.14.0",
    "node-addon-api": "^3.0.0"
  }
}

配置文件介绍

• name: 项目名称。
• version: 项目版本。
• description: 项目描述。
• main: 项目的入口文件，这里是 test_all.js。
• scripts: 包含可执行的脚本命令，例如 test 命令用于运行测试。
• dependencies: 项目的依赖项，包括 nan 和 node-addon-api。

通过这些配置，你可以轻松地管理项目的依赖和执行测试。

node-addon-examples Node.js C++ addon examples from http://nodejs.org/docs/latest/api/addons.html 项目地址: https://gitcode.com/gh_mirrors/no/node-addon-examples