• Version 3.2.9
  • Published
  • 211 kB
  • 14 dependencies
  • MIT license


npm i electron-rebuild
yarn add electron-rebuild
pnpm add electron-rebuild


Electron supporting package to rebuild native node modules against the currently installed electron



function rebuild

rebuild: (options: RebuildOptions) => RebuildResult;


    interface RebuildOptions

    interface RebuildOptions {}

      property arch

      arch?: string;

        property buildPath

        buildPath: string;

          property cachePath

          cachePath?: string;

            property debug

            debug?: boolean;

              property disablePreGypCopy

              disablePreGypCopy?: boolean;

                property electronVersion

                electronVersion: string;

                  property extraModules

                  extraModules?: string[];

                    property force

                    force?: boolean;

                      property forceABI

                      forceABI?: number;

                        property headerURL

                        headerURL?: string;

                          property mode

                          mode?: RebuildMode;

                            property onlyModules

                            onlyModules?: string[] | null;

                              property prebuildTagPrefix

                              prebuildTagPrefix?: string;

                                property projectRootPath

                                projectRootPath?: string;

                                  property types

                                  types?: ModuleType[];

                                    property useCache

                                    useCache?: boolean;

                                      property useElectronClang

                                      useElectronClang?: boolean;

                                        Package Files (2)

                                        Dependencies (14)

                                        Dev Dependencies (27)

                                        Peer Dependencies (0)

                                        No peer dependencies.


                                        To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                                        You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/electron-rebuild.

                                        • Markdown
                                        • HTML
                                          <a href="https://www.jsdocs.io/package/electron-rebuild"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>