Этот раздел проведёт вас через всё необходимое, чтобы начать создавать нативные аддоны Node.js с помощью Node-API. Он рассчитан на разработчиков, которые впервые сталкиваются с разработкой нативных аддонов и хотят пройти по направляемому пути от нуля до рабочего модуля.
- Пре-реквизиты — какие знания C/C++ и JavaScript вам нужны, прежде чем нырять
- Инструменты, которые вам понадобятся — как установить Node, npm, Git и C/C++-тулчейн на Windows, macOS и Linux
- Анатомия Node-API-проекта — типичная структура директорий, записи в
package.json,binding.gypи слой JavaScript-обёртки, общий для каждого проекта наnode-addon-api - Ваш первый проект — сборка и запуск вашего первого модуля Node-API
- ObjectWrap — предоставление C++-объектов как JavaScript-объектов с помощью класса
ObjectWrapизnode-addon-api - Миграция с NAN — конвертация существующего аддона на основе NAN в Node-API
Node-API работает на двух уровнях:
- C API — встроен непосредственно в Node.js и задокументирован на страницах API Node.js. Даёт максимальный контроль и никаких лишних зависимостей.
- C++-обёртка (
node-addon-api) — npm-пакет, оборачивающий C API в более дружелюбную объектную модель C++. Рекомендуется для большинства проектов, потому что значительно уменьшает объём шаблонного кода, сохраняя при этом полную ABI-стабильность.
Примеры в этом разделе используют node-addon-api.