Node.js
node-addon-api
Learn the node-addon-api C++ wrapper.
node-addon-api
node-addon-api is a C++ wrapper built on top of N-API. Instead of raw N-API C calls you work with C++ classes, which makes the code more readable and less error-prone. The node-addon-api header is included in a single line.
An addonWrapper(className, methods) function models this wrapper idea: it takes a class name and a methods list, returning {class, methods, wrapper: 'node-addon-api'}. In real node-addon-api a C++ class is bound to a JS class with Napi::ObjectWrap. Here we model it in JS to understand what the wrapper does: it hides complex C calls behind class methods. The output is node-addon-api, the wrapper's name.
The wrapper pattern
The core pattern of node-addon-api is: you define a C++ class, declare its methods, then expose it to JS. addonWrapper models this by returning an object. The .wrapper property tells which wrapper is used.
Example: addonWrapper('Calculator', ['add', 'subtract']) returns {class: 'Calculator', methods: ['add', 'subtract'], wrapper: 'node-addon-api'}. .wrapper is 'node-addon-api'. This pattern represents a real addon's structure with a simple object: class name, methods and a wrapper. Although the real code is C++, the structure is the same: a class, a method list and a binding mechanism. console.log(...wrapper) verifies which wrapper is used.
Exercise Write the wrapper function
Write function addonWrapper(className, methods). Return {class: className, methods: methods, wrapper: 'node-addon-api'}. Print console.log(addonWrapper('Calculator', ['add', 'subtract']).wrapper).
Show example solution
function addonWrapper(className, methods) {
return {class: className, methods: methods, wrapper: 'node-addon-api'};
}
console.log(addonWrapper('Calculator', ['add', 'subtract']).wrapper);
Test yourself
-
Return the methods list
function addonWrapper(className, methods) { return {class: className, methods: ____, wrapper: 'node-addon-api'}; }
Show answer
function addonWrapper(className, methods) { return {class: className, methods: methods, wrapper: 'node-addon-api'}; }
-
Match each concept to its description
- node-addon-api
- C++ wrapper
- Napi::ObjectWrap
- Binds a C++ class to JS
- wrapper
- The wrapper name
- methods
- The method list
-
What does addonWrapper(...).wrapper return?
addonWrapper('Calculator', ['add']).wrapper
- 'Calculator'
- 'add'
- 'node-addon-api'
- ['add']
Show answer
'node-addon-api' — The .wrapper property returns 'node-addon-api'.
Next lesson: Binding
