Skip to content

Latest commit

 

History

History
39 lines (31 loc) · 1.55 KB

auto-unpack-natives.md

File metadata and controls

39 lines (31 loc) · 1.55 KB
description
Reduce loading times and disk consumption by unpacking native Node modules from your Forge app's ASAR archive.

Auto Unpack Native Modules Plugin

This plugin will automatically add all native Node modules in your node_modules folder to the asar.unpack config option in your packagerConfig. If your app uses native Node modules, you should probably use this to reduce loading times and disk consumption on your users' machines.

Installation

npm install --save-dev @electron-forge/plugin-auto-unpack-natives

Usage

You must add this plugin to your plugins array in your Forge configuration. There are currently no configuration options available for this plugin.

{% hint style="info" %} Asar archives are disabled by default with Electron Packager. Make sure you set your packagerConfig.asar value accordingly. This option also supports advanced configuration if you pass it an object. See the API documentation for this option for more information. {% endhint %}

{% code title="forge.config.js" %}

module.exports = {
  packagerConfig: {
    asar: true // or an object containing your asar options
  },
  plugins: [
    {
      name: '@electron-forge/plugin-auto-unpack-natives',
      config: {}
    }
  ]
};

{% endcode %}