Node Native Loader
Package for loading native files in Node and Electron applications. The project is inspired by the node-addon-loader. It works in the similar way but allows to build path at runtime.
Installation
Add the package to the development dependencies:
# using npm:
$ npm install native-ext-loader --save-dev
# using yarn:
$ yarn add --dev native-ext-loader
Usage
Update rules entry in the Webpack configuration file:
module: {
rules: [
{
test: /\.node$/,
loader: "native-ext-loader"
}
];
}
Options
Options are configurable using options hash:
module: {
rules: [
{
test: /\.node$/,
loader: "native-ext-loader",
options: {
rewritePath: path.resolve(__dirname, "dist")
}
}
];
}
basePath (default: [])
It allows adjusting path to the native module. The array will be concatenated with the resource name and then used in the runtime. For example, when the compile application lives inside app.asar/renderer subdirectory (Electron package), the path to the native module can be adjusted by using basePath: ['app.asar', 'renderer'].
Note that basePath is ignored when rewritePath option is used.
rewritePath (default: undefined)
It allows to set an absolute paths to native files.
Note that it needs to remain undefined if you are building a package with embedded files. This way, the compiled application will work no matter of its location. This is important when building Electron applications that can be placed in any directory by the end user.
emit (default: true)
Specifies whether the imported .node file will be copied to the output directory.
Releasing a new version
- Bump version number in the
package.json and CHANGELOG.md files.
- Run
npm install to update package-lock.json file.
- Commit changes (include changes)
- Add a new tag (use
-a and include changes)
- Push commits and tag
- Run
npm publish
