canirequire › CommonJS › node-addon-api
Is node-addon-api ESM-only? Can you require() it?
Node.js API (Node-API)
Last verified Sep 9, 2026 against node-addon-api@8.9.2. Markdown · JSON
CommonJS CommonJS — require() works on every Node.js version we test
node-addon-api ships CommonJS only. require("node-addon-api") works on every Node.js version we test (18, 20, 22, 24 and 26) and in Bun. The package declares Node.js ^18 || ^20 || >= 21. import "node-addon-api" also works because Node.js and Bun can import CommonJS from ES modules, but only the default export is guaranteed; named imports depend on Node's static analysis of the module.
What to do
- require("node-addon-api") works on every Node.js version we test (18, 20, 22, 24 and 26) and in Bun. The package declares Node.js ^18 || ^20 || >= 21.
- From ES modules use the default import: import nodeAddonApi from "node-addon-api"; then destructure. Named imports only work when Node.js can statically detect the exports.
- TypeScript: no types are available for node-addon-api; declare the module yourself if you need them.
Does node-addon-api@8.9.2 actually load? Runtime test results
Installed and executed on Sep 9, 2026 with require("node-addon-api") from a CommonJS file and import "node-addon-api" from an ES module.
| Runtime | require("node-addon-api") | import "node-addon-api" |
|---|---|---|
| Node.js 18 | ✓ works | ✓ works |
| Node.js 20 | ✓ works | ✓ works |
| Node.js 22 | ✓ works | ✓ works |
| Node.js 24 | ✓ works | ✓ works |
| Node.js 26 | ✓ works | ✓ works |
| Bun 1.4.0 | ✓ works | ✓ works |
How to import node-addon-api
ES modules (import)
import nodeAddonApi from "node-addon-api";Named imports from a CommonJS package only work when Node.js can statically detect them. If a named import fails, use the default import and destructure.
CommonJS (require)
const nodeAddonApi = require("node-addon-api");Module format by version
Derived from the type, main and exports fields of every stable release on npm, corrected where a runtime test of that version contradicted them (59 versions; the newest 59 shown).
| Versions | Format | First published |
|---|---|---|
| 0.1.0 – 8.9.2 | CommonJS | May 4, 2017 |
Frequently asked
Is node-addon-api ESM-only?
node-addon-api@8.9.2 is a CommonJS package. node-addon-api ships CommonJS only. require("node-addon-api") works on every Node.js version we test (18, 20, 22, 24 and 26) and in Bun. The package declares Node.js ^18 || ^20 || >= 21. import "node-addon-api" also works because Node.js and Bun can import CommonJS from ES modules, but only the default export is guaranteed; named imports depend on Node's static analysis of the module.
Can I import node-addon-api with ES module syntax?
Yes. import nodeAddonApi from "node-addon-api" works in Node.js and Bun because they support importing CommonJS modules. Named imports work only when Node.js can statically detect the exports.
Does node-addon-api work in Bun?
Yes. import "node-addon-api" loaded successfully in Bun 1.4.0 on Sep 9, 2026.
Does node-addon-api ship TypeScript types?
No. node-addon-api ships no type declarations and there is no @types package for it.
Links
Other commonjs packages
- debug 4.4.3CommonJS
- semver 7.8.5CommonJS
- ms 2.1.3CommonJS
- picomatch 4.0.7CommonJS
- ajv 8.20.0CommonJS
- source-map 0.8.0CommonJS
- react-is 19.2.8CommonJS
- readable-stream 4.7.0CommonJS
Similar popularity
- buffer-crc32 1.0.0Dual
- @img/sharp-linux-x64 0.35.4CommonJS
- react-remove-scroll 2.7.2CommonJS
- @radix-ui/react-collection 1.1.15Dual
- d3-ease 3.0.1ESM-only
- events 3.3.0CommonJS
- @babel/helper-create-class-features-plugin 8.0.1ESM-only
- @smithy/util-buffer-from 4.5.2CommonJS