@electron/rebuild
    Preparing search index...

    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[];
        jobs?: number;
        mode?: RebuildMode;
        onlyModules?: string[] | null;
        platform?: Platform;
        prebuildTagPrefix?: string;
        projectRootPath?: string;
        types?: ModuleType[];
        useCache?: boolean;
        useElectronClang?: boolean;
    }
    Index

    Properties

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

    Properties

    arch?: string

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

    The system process.arch value

    buildFromSource?: boolean

    Skip prebuild download and rebuild module from source.

    false
    buildPath: string

    The path to the node_modules directory to rebuild.

    cachePath?: string

    Sets a custom cache path for the useCache option.

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

    debug?: boolean

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

    false
    disablePreGypCopy?: boolean

    Disables the copying of .node files if not needed.

    false
    electronVersion: string

    The version of Electron to build against.

    extraModules?: string[]

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

    []
    force?: boolean

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

    forceABI?: number

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

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

    headerURL?: string

    URL to download Electron header files from.

    https://www.electronjs.org/headers

    ignoreModules?: string[]

    Array of module names to ignore during the rebuild process.

    jobs?: number

    Number of parallel compile jobs node-gyp should run, passed through as node-gyp's --jobs flag.

    node-gyp's own default when unset
    mode?: RebuildMode

    Whether to rebuild modules sequentially or in parallel.

    sequential

    onlyModules?: string[] | null

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

    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.

    The system process.platform value

    prebuildTagPrefix?: string

    GitHub tag prefix passed to prebuild-install.

    v

    projectRootPath?: string

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

    types?: ModuleType[]

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

    ['prod', 'optional']

    useCache?: boolean

    Enables hash-based caching to speed up local rebuilds.

    false
    useElectronClang?: boolean

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

    false

    Settings

    Member Visibility

    On This Page

    Properties