Interface RebuildOptions

interface RebuildOptions {
    arch?: string;
    buildFromSource?: boolean;
    buildPath: string;
    cachePath?: string;
    debug?: boolean;
    disablePreGypCopy?: boolean;
    electronVersion: string;
    extraModules?: string[];
    force?: boolean;
    forceABI?: number;
    headerURL?: string;
    ignoreModules?: string[];
    mode?: RebuildMode;
    onlyModules?: null | string[];
    platform?: Platform;
    prebuildTagPrefix?: string;
    projectRootPath?: string;
    types?: ModuleType[];
    useCache?: boolean;
    useElectronClang?: boolean;
}

Properties

arch? buildFromSource? buildPath cachePath? debug? disablePreGypCopy? electronVersion extraModules? force? forceABI? headerURL? ignoreModules? mode? onlyModules? platform? prebuildTagPrefix? projectRootPath? types? useCache? useElectronClang?

Properties

Optional arch

arch?: string

Override the target rebuild architecture to something other than the host system architecture.

Default Value

The system {@link https://nodejs.org/api/process.html#processarch | `process.arch`} value

Optional buildFromSource

buildFromSource?: boolean

Skip prebuild download and rebuild module from source.

Default Value

false

buildPath

buildPath: string

The path to the node_modules directory to rebuild.

Optional Experimental cachePath

cachePath?: string

Sets a custom cache path for the useCache option.

Default Value

a .electron-rebuild-cache folder in the os.homedir() directory

Optional debug

debug?: boolean

Rebuilds a Debug build of target modules. If this is false, a Release build will be generated instead.

Default Value

false

Optional disablePreGypCopy

disablePreGypCopy?: boolean

Disables the copying of .node files if not needed.

Default Value

false

electronVersion

electronVersion: string

The version of Electron to build against.

Optional extraModules

extraModules?: string[]

An array of module names to rebuild in addition to detected modules

Default

[]

Optional force

force?: boolean

Force a rebuild of modules regardless of their current build state.

Optional forceABI

forceABI?: number

Override the Application Binary Interface (ABI) version for the version of Electron you are targeting. Only use when targeting nightly releases.

See

the electron/node-abi repository for a list of Electron and Node.js ABIs

Optional headerURL

headerURL?: string

URL to download Electron header files from.

Default Value

https://www.electronjs.org/headers

Optional ignoreModules

ignoreModules?: string[]

Array of module names to ignore during the rebuild process.

Optional mode

mode?: RebuildMode

Whether to rebuild modules sequentially or in parallel.

Default Value

sequential

Optional onlyModules

onlyModules?: null | string[]

An array of module names to rebuild. Only these modules will be rebuilt.

Optional platform

platform?: Platform

Override the target platform to something other than the host system platform. Note: This only applies to downloading prebuilt binaries. It is not possible to cross-compile native modules.

Default Value

The system {@link https://nodejs.org/api/process.html#processplatform | `process.platform`} value

Optional prebuildTagPrefix

prebuildTagPrefix?: string

GitHub tag prefix passed to prebuild-install.

Default Value

v

Optional projectRootPath

projectRootPath?: string

Path to the root of the project if using npm or yarn workspaces.

Optional types

types?: ModuleType[]

Array of types of dependencies to rebuild. Possible values are prod, dev, and optional.

Default Value

['prod', 'optional']

Optional Experimental useCache

useCache?: boolean

Enables hash-based caching to speed up local rebuilds.

Default Value

false

Optional useElectronClang

useElectronClang?: boolean

Whether to use the clang executable that Electron uses when building. This will guarantee compiler compatibility.

Default Value

false

Settings

Member Visibility

Theme

On This Page

archbuildFromSourcebuildPathcachePathdebugdisablePreGypCopyelectronVersionextraModulesforceforceABIheaderURLignoreModulesmodeonlyModulesplatformprebuildTagPrefixprojectRootPathtypesuseCacheuseElectronClang