Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

electron-node-loader

Package Overview
Dependencies
Maintainers
1
Versions
10
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

electron-node-loader

A webpack loader that allows you loader native Node addons inside an Electron app.

  • 1.2.0
  • latest
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
4
decreased by-20%
Maintainers
1
Weekly downloads
 
Created
Source

electron-node-loader

yarn

This Webpack modules allows you to load a native Node.js C++ addon that can be shipped inside an Electron application.

Usage:

Let's picture an application folder:

project/
├── dist/
├── src/
│   └── main.js
└── scripts/
    └── addon.node

From your JavaScript code, you should be importing your custom module that way:

import * as addon from '../scripts/addon.node';

...

addon.doStuff();

When building your Electron app during development, add this rule to your Webpack config file:

loaders: [
  {
    test: /\.node?$/,
    use: [
      {
      	loader: 'electron-node-loader',
      	options: {
      	  folder: 'scripts'
      	}
      }
    ]
  }
]

If you're using electorn-builder for production, just add prod: true to the options object of the loader. You also need to add these lines in your package.json:

"files": [
  "!scripts",
],
"extraResources": [
  "scripts/*.node",
]

That way, your native addons with be shipped in a special resources directory inside of your app and your production JavaScript will be looking for them at runtime with a relative path.

FAQs

Package last updated on 17 Sep 2018

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc