From d2ae705532e82a3c02df2e3b39cfedda6e9a6854 Mon Sep 17 00:00:00 2001 From: "electron-ecosystem-docs-publisher[bot]" <148823412+electron-ecosystem-docs-publisher[bot]@users.noreply.github.com> Date: Sat, 1 Feb 2025 13:28:34 +0000 Subject: [PATCH] Publish [skip ci] --- ...allOfficialArchsForPlatformAndVersion.html | 2 +- main/functions/packager.html | 2 +- main/functions/serialHooks.html | 2 +- main/interfaces/MacOSProtocol.html | 6 +- main/interfaces/Options.html | 94 +++++++++---------- main/interfaces/OsxSignOptions.html | 2 +- main/interfaces/OsxUniversalOptions.html | 2 +- main/interfaces/Win32MetadataOptions.html | 16 ++-- main/interfaces/WindowsSignOptions.html | 4 +- main/types/ArchOption.html | 2 +- .../FinalizePackageTargetsHookFunction.html | 2 +- main/types/HookFunction.html | 2 +- main/types/HookFunctionErrorCallback.html | 2 +- main/types/IgnoreFunction.html | 2 +- main/types/OfficialArch.html | 2 +- main/types/OfficialPlatform.html | 2 +- main/types/PlatformOption.html | 2 +- main/types/SupportedArch.html | 2 +- main/types/SupportedPlatform.html | 2 +- main/types/TargetArch.html | 2 +- main/types/TargetDefinition.html | 2 +- main/types/TargetPlatform.html | 2 +- 22 files changed, 78 insertions(+), 78 deletions(-) diff --git a/main/functions/allOfficialArchsForPlatformAndVersion.html b/main/functions/allOfficialArchsForPlatformAndVersion.html index 83dcc0be..b3ea4f35 100644 --- a/main/functions/allOfficialArchsForPlatformAndVersion.html +++ b/main/functions/allOfficialArchsForPlatformAndVersion.html @@ -1 +1 @@ -allOfficialArchsForPlatformAndVersion | @electron/packager

Function allOfficialArchsForPlatformAndVersion

Settings

Member Visibility

Theme

\ No newline at end of file +allOfficialArchsForPlatformAndVersion | @electron/packager

Function allOfficialArchsForPlatformAndVersion

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/main/functions/packager.html b/main/functions/packager.html index c0ba150b..eba691b4 100644 --- a/main/functions/packager.html +++ b/main/functions/packager.html @@ -9,4 +9,4 @@

Returns Promise<string[]>

A Promise containing the paths to the newly created application bundles.

Example

const packager = require('@electron/packager')

async function bundleElectronApp(options) {
  const appPaths = await packager(options)
  console.log(`Electron app bundles created:\n${appPaths.join("\n")}`)
}
-

Settings

Member Visibility

Theme

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/main/functions/serialHooks.html b/main/functions/serialHooks.html index 55ab3c67..942193bf 100644 --- a/main/functions/serialHooks.html +++ b/main/functions/serialHooks.html @@ -3,4 +3,4 @@ If you need the functions called serially, you can use the serialHooks utility function:

const { packager, serialHooks } = require('@electron/packager')

packager({
  // ...
  afterCopy: [serialHooks([
    (buildPath, electronVersion, platform, arch, callback) => {
      setTimeout(() => {
        console.log('first function')
        callback()
      }, 1000)
    },
    (buildPath, electronVersion, platform, arch, callback) => {
      console.log('second function')
      callback()
    }
  ])],
  // ...
})
-

Parameters

Returns ((...serialHookParams) => Promise<void>)

Settings

Member Visibility

Theme

\ No newline at end of file +

Parameters

Returns ((...serialHookParams) => Promise<void>)

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/main/interfaces/MacOSProtocol.html b/main/interfaces/MacOSProtocol.html index 50cef8a9..56d75c6f 100644 --- a/main/interfaces/MacOSProtocol.html +++ b/main/interfaces/MacOSProtocol.html @@ -1,8 +1,8 @@ MacOSProtocol | @electron/packager

Interface MacOSProtocol

Defines URL protocol schemes to be used on macOS.

-
interface MacOSProtocol {
    name: string;
    schemes: string[];
}

Properties

name +
interface MacOSProtocol {
    name: string;
    schemes: string[];
}

Properties

name schemes

Properties

name

name: string

The descriptive name. Maps to the CFBundleURLName metadata property.

-

schemes

schemes: string[]

One or more protocol schemes associated with the app. For example, specifying myapp +

schemes

schemes: string[]

One or more protocol schemes associated with the app. For example, specifying myapp would cause URLs such as myapp://path to be opened with the app. Maps to the CFBundleURLSchemes metadata property.

-

Settings

Member Visibility

Theme

On This Page

nameschemes
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

nameschemes
\ No newline at end of file diff --git a/main/interfaces/Options.html b/main/interfaces/Options.html index 13ead760..91b0bfaf 100644 --- a/main/interfaces/Options.html +++ b/main/interfaces/Options.html @@ -1,5 +1,5 @@ Options | @electron/packager

Interface Options

Options passed to the packager() function.

-
interface Options {
    dir: string;
    afterAsar?: HookFunction[];
    afterComplete?: HookFunction[];
    afterCopy?: HookFunction[];
    afterCopyExtraResources?: HookFunction[];
    afterExtract?: HookFunction[];
    afterFinalizePackageTargets?: FinalizePackageTargetsHookFunction[];
    afterInitialize?: HookFunction[];
    afterPrune?: HookFunction[];
    all?: boolean;
    appBundleId?: string;
    appCategoryType?: string;
    appCopyright?: string;
    appVersion?: string;
    arch?: string | string[];
    asar?: boolean | CreateOptions;
    beforeAsar?: HookFunction[];
    beforeCopy?: HookFunction[];
    beforeCopyExtraResources?: HookFunction[];
    buildVersion?: string;
    darwinDarkModeSupport?: boolean;
    derefSymlinks?: boolean;
    download?: ElectronDownloadRequestOptions;
    electronVersion?: string;
    electronZipDir?: string;
    executableName?: string;
    extendHelperInfo?: string | {
        [property: string]: any;
    };
    extendInfo?: string | {
        [property: string]: any;
    };
    extraResource?: string | string[];
    helperBundleId?: string;
    icon?: string;
    ignore?: RegExp | (string | RegExp)[] | IgnoreFunction;
    junk?: boolean;
    name?: string;
    osxNotarize?: NotaryToolCredentials;
    osxSign?: true | OsxSignOptions;
    osxUniversal?: OsxUniversalOptions;
    out?: string;
    overwrite?: boolean;
    platform?: string | string[];
    prebuiltAsar?: string;
    protocols?: MacOSProtocol[];
    prune?: boolean;
    quiet?: boolean;
    tmpdir?: string | false;
    usageDescription?: {
        [property: string]: string;
    };
    win32metadata?: Win32MetadataOptions;
    windowsSign?: true | WindowsSignOptions;
}

Other

dir +
interface Options {
    dir: string;
    afterAsar?: HookFunction[];
    afterComplete?: HookFunction[];
    afterCopy?: HookFunction[];
    afterCopyExtraResources?: HookFunction[];
    afterExtract?: HookFunction[];
    afterFinalizePackageTargets?: FinalizePackageTargetsHookFunction[];
    afterInitialize?: HookFunction[];
    afterPrune?: HookFunction[];
    all?: boolean;
    appBundleId?: string;
    appCategoryType?: string;
    appCopyright?: string;
    appVersion?: string;
    arch?: string | string[];
    asar?: boolean | CreateOptions;
    beforeAsar?: HookFunction[];
    beforeCopy?: HookFunction[];
    beforeCopyExtraResources?: HookFunction[];
    buildVersion?: string;
    darwinDarkModeSupport?: boolean;
    derefSymlinks?: boolean;
    download?: ElectronDownloadRequestOptions;
    electronVersion?: string;
    electronZipDir?: string;
    executableName?: string;
    extendHelperInfo?: string | {
        [property: string]: any;
    };
    extendInfo?: string | {
        [property: string]: any;
    };
    extraResource?: string | string[];
    helperBundleId?: string;
    icon?: string;
    ignore?: RegExp | (string | RegExp)[] | IgnoreFunction;
    junk?: boolean;
    name?: string;
    osxNotarize?: NotaryToolCredentials;
    osxSign?: true | OsxSignOptions;
    osxUniversal?: OsxUniversalOptions;
    out?: string;
    overwrite?: boolean;
    platform?: string | string[];
    prebuiltAsar?: string;
    protocols?: MacOSProtocol[];
    prune?: boolean;
    quiet?: boolean;
    tmpdir?: string | false;
    usageDescription?: {
        [property: string]: string;
    };
    win32metadata?: Win32MetadataOptions;
    windowsSign?: true | WindowsSignOptions;
}

Other

dir afterAsar? afterComplete? afterCopy? @@ -48,27 +48,27 @@ protocols? usageDescription?

Other

dir

dir: string

The source directory.

-

Optional afterAsar

afterAsar?: HookFunction[]

Functions to be called after your app directory has been packaged into an .asar file.

+

Optional afterAsar

afterAsar?: HookFunction[]

Functions to be called after your app directory has been packaged into an .asar file.

Note: afterAsar will only be called if the asar option is set.

-

Optional afterComplete

afterComplete?: HookFunction[]

Functions to be called after the packaged application has been moved to the final directory.

-

Optional afterCopy

afterCopy?: HookFunction[]

Functions to be called after your app directory has been copied to a temporary directory.

+

Optional afterComplete

afterComplete?: HookFunction[]

Functions to be called after the packaged application has been moved to the final directory.

+

Optional afterCopy

afterCopy?: HookFunction[]

Functions to be called after your app directory has been copied to a temporary directory.

Note: afterCopy will not be called if the prebuiltAsar option is set.

-

Optional afterCopyExtraResources

afterCopyExtraResources?: HookFunction[]

Functions to be called after the files specified in the extraResource option have been copied.

-

Optional afterExtract

afterExtract?: HookFunction[]

Functions to be called after the prebuilt Electron binary has been extracted to a temporary directory.

-

Optional afterFinalizePackageTargets

afterFinalizePackageTargets?: FinalizePackageTargetsHookFunction[]

Functions to be called after the final matrix of platform/arch combination is determined. Use this to +

Optional afterCopyExtraResources

afterCopyExtraResources?: HookFunction[]

Functions to be called after the files specified in the extraResource option have been copied.

+

Optional afterExtract

afterExtract?: HookFunction[]

Functions to be called after the prebuilt Electron binary has been extracted to a temporary directory.

+

Optional afterFinalizePackageTargets

afterFinalizePackageTargets?: FinalizePackageTargetsHookFunction[]

Functions to be called after the final matrix of platform/arch combination is determined. Use this to learn what archs/platforms packager is targetting when you pass "all" as a value.

-

Optional afterInitialize

afterInitialize?: HookFunction[]

Optional afterPrune

afterPrune?: HookFunction[]

Functions to be called after Node module pruning has been applied to the application.

+

Optional afterInitialize

afterInitialize?: HookFunction[]

Optional afterPrune

afterPrune?: HookFunction[]

Functions to be called after Node module pruning has been applied to the application.

Note: None of these functions will be called if the prune option is false or the prebuiltAsar option is set.

-

Optional all

all?: boolean

When true, sets both arch and platform to all.

-

Optional appBundleId

appBundleId?: string

Optional appCopyright

appCopyright?: string

The human-readable copyright line for the app. Maps to the LegalCopyright metadata +

Optional all

all?: boolean

When true, sets both arch and platform to all.

+

Optional appBundleId

appBundleId?: string

Optional appCopyright

appCopyright?: string

The human-readable copyright line for the app. Maps to the LegalCopyright metadata property on Windows, and NSHumanReadableCopyright on macOS.

-

Optional appVersion

appVersion?: string

The release version of the application.

+

Optional appVersion

appVersion?: string

The release version of the application.

By default the version property in the package.json is used, but it can be overridden with this argument. If neither are provided, the version of Electron will be used. Maps to the ProductVersion metadata property on Windows, and CFBundleShortVersionString on macOS.

-

Optional arch

arch?: string | string[]

The target system architecture(s) to build for.

+

Optional arch

arch?: string | string[]

The target system architecture(s) to build for.

Not required if the all option is set. If arch is set to all, all supported architectures for the target platforms specified by platform will be built. Arbitrary combinations of individual architectures are also supported via a comma-delimited @@ -84,7 +84,7 @@

  • arm64 (Linux: Electron 1.8.0 and above; Windows: 6.0.8 and above; macOS: 11.0.0-beta.1 and above)
  • mips64el (Electron 1.8.2-beta.5 to 1.8.8)
    • -

    Optional asar

    asar?: boolean | CreateOptions

    Whether to package the application's source code into an archive, using Electron's +

    Optional asar

    asar?: boolean | CreateOptions

    Whether to package the application's source code into an archive, using Electron's archive format. Reasons why you may want to enable this feature include mitigating issues around long path names on Windows, slightly speeding up require, and concealing your source code from cursory inspection. When the value @@ -108,17 +108,17 @@

  • asar.unpackDir = path.join('**', '{sub_dir1/sub_sub_dir,sub_dir2}', '**', '*') will unpack the directories /<dir>/sub_dir1/sub_sub_dir and /<dir>/sub_dir2 and their subdirectories.

    • Note: asar will have no effect if the prebuiltAsar option is set.

    -

    Optional beforeAsar

    beforeAsar?: HookFunction[]

    Functions to be called before your app directory is packaged into an .asar file.

    +

    Optional beforeAsar

    beforeAsar?: HookFunction[]

    Functions to be called before your app directory is packaged into an .asar file.

    Note: beforeAsar will only be called if the asar option is set.

    -

    Optional beforeCopy

    beforeCopy?: HookFunction[]

    Functions to be called before your app directory is copied to a temporary directory.

    +

    Optional beforeCopy

    beforeCopy?: HookFunction[]

    Functions to be called before your app directory is copied to a temporary directory.

    Note: beforeCopy will not be called if the prebuiltAsar option is set.

    -

    Optional beforeCopyExtraResources

    beforeCopyExtraResources?: HookFunction[]

    Functions to be called before the files specified in the extraResource option are copied.

    -

    Optional buildVersion

    buildVersion?: string

    The build version of the application. Defaults to the value of the appVersion option. +

    Optional beforeCopyExtraResources

    beforeCopyExtraResources?: HookFunction[]

    Functions to be called before the files specified in the extraResource option are copied.

    +

    Optional buildVersion

    buildVersion?: string

    The build version of the application. Defaults to the value of the appVersion option. Maps to the FileVersion metadata property on Windows, and CFBundleVersion on macOS.

    -

    Optional derefSymlinks

    derefSymlinks?: boolean

    Whether symlinks should be dereferenced during the copying of the application source. +

    Optional derefSymlinks

    derefSymlinks?: boolean

    Whether symlinks should be dereferenced during the copying of the application source. Defaults to true.

    Note: derefSymlinks will have no effect if the prebuiltAsar option is set.

    -

    Optional download

    download?: ElectronDownloadRequestOptions

    If present, passes custom options to @electron/get. See +

    Optional download

    download?: ElectronDownloadRequestOptions

    If present, passes custom options to @electron/get. See the module for option descriptions, proxy support, and defaults. Supported parameters include, but are not limited to:

      @@ -126,26 +126,26 @@
    • mirrorOptions (Object): Options to override the default Electron download location.

    Note: download sub-options will have no effect if the electronZipDir option is set.

    -

    Optional electronVersion

    electronVersion?: string

    The Electron version with which the app is built (without the leading 'v') - for example, +

    Optional electronVersion

    electronVersion?: string

    The Electron version with which the app is built (without the leading 'v') - for example, 1.4.13. See Electron releases for valid versions. If omitted, it

    • will use the version of the nearest local installation of electron or electron-nightly
    • defined in package.json in either devDependencies or dependencies.
    -

    Optional electronZipDir

    electronZipDir?: string

    The local path to a directory containing Electron ZIP files for Electron Packager to unzip, instead +

    Optional electronZipDir

    electronZipDir?: string

    The local path to a directory containing Electron ZIP files for Electron Packager to unzip, instead of downloading them. The ZIP filenames should be in the same format as the ones downloaded from the Electron releases site.

    Note: Setting this option prevents the download sub-options from being used, as the functionality gets skipped over.

    -

    Optional executableName

    executableName?: string

    The name of the executable file, sans file extension. Defaults to the value for the name +

    Optional executableName

    executableName?: string

    The name of the executable file, sans file extension. Defaults to the value for the name option. For darwin or mas target platforms, this does not affect the name of the .app folder - this will use the name option instead.

    -

    Optional extraResource

    extraResource?: string | string[]

    One or more files to be copied directly into the app's Contents/Resources directory for +

    Optional extraResource

    extraResource?: string | string[]

    One or more files to be copied directly into the app's Contents/Resources directory for macOS target platforms, and the resources directory for other target platforms. The resources directory can be referenced in the packaged app via the process.resourcesPath value.

    -

    Optional icon

    icon?: string

    The local path to the icon file, if the target platform supports setting embedding an icon.

    +

    Optional icon

    icon?: string

    The local path to the icon file, if the target platform supports setting embedding an icon.

    Currently you must look for conversion tools in order to supply an icon in the format required by the platform:

    • macOS: .icns
      • @@ -157,7 +157,7 @@

    If the file extension is omitted, it is auto-completed to the correct extension based on the platform, including when platform: 'all' is in effect.

    -

    Optional ignore

    ignore?: RegExp | (string | RegExp)[] | IgnoreFunction

    One or more additional regular expression +

    Optional ignore

    ignore?: RegExp | (string | RegExp)[] | IgnoreFunction

    One or more additional regular expression patterns which specify which files to ignore when copying files to create the app bundle(s). The regular expressions are matched against the absolute path of a given file/directory to be copied.

    Please note that glob patterns will not work.

    @@ -179,21 +179,21 @@

    Note: Node modules specified in devDependencies are ignored by default, via the prune option.

    Note: ignore will have no effect if the prebuiltAsar option is set.

    -

    Optional junk

    junk?: boolean

    Ignores system junk files when copying the Electron app, +

    Optional junk

    junk?: boolean

    Ignores system junk files when copying the Electron app, regardless of the ignore option.

    Note: junk will have no effect if the prebuiltAsar option is set.

    -

    Optional name

    name?: string

    The application name. If omitted, it will use the productName or name value from the +

    Optional name

    name?: string

    The application name. If omitted, it will use the productName or name value from the nearest package.json.

    Regardless of source, characters in the Electron app name which are not allowed in all target platforms' filenames (e.g., /), will be replaced by hyphens (-).

    -

    Optional osxUniversal

    osxUniversal?: OsxUniversalOptions

    Used to provide custom options to the internal call to @electron/universal when building a macOS +

    Optional osxUniversal

    osxUniversal?: OsxUniversalOptions

    Used to provide custom options to the internal call to @electron/universal when building a macOS app with the target architecture of "universal". Unused otherwise, providing a value does not imply a universal app is built.

    -

    Optional out

    out?: string

    The base directory where the finished package(s) are created.

    +

    Optional out

    out?: string

    The base directory where the finished package(s) are created.

    Defaults to the current working directory.

    -

    Optional overwrite

    overwrite?: boolean

    Whether to replace an already existing output directory for a given platform (true) or +

    Optional overwrite

    overwrite?: boolean

    Whether to replace an already existing output directory for a given platform (true) or skip recreating it (false). Defaults to false.

    -

    Optional platform

    platform?: string | string[]

    The target platform(s) to build for.

    +

    Optional platform

    platform?: string | string[]

    The target platform(s) to build for.

    Not required if the all option is set. If platform is set to all, all officially supported target platforms for the target architectures specified by the arch option will be built. Arbitrary combinations of individual platforms are also supported via a @@ -209,7 +209,7 @@

  • mas (macOS, specifically for submitting to the Mac App Store)
  • win32
    • -

    Optional prebuiltAsar

    prebuiltAsar?: string

    The path to a prebuilt ASAR file.

    +

    Optional prebuiltAsar

    prebuiltAsar?: string

    The path to a prebuilt ASAR file.

    Note: Setting this option prevents the following options from being used, as the functionality gets skipped over:

    -

    Optional prune

    prune?: boolean

    Walks the node_modules dependency tree to remove all of the packages specified in the +

    Optional prune

    prune?: boolean

    Walks the node_modules dependency tree to remove all of the packages specified in the devDependencies section of package.json from the outputted Electron app.

    Defaults to true.

    Note: prune will have no effect if the prebuiltAsar option is set.

    -

    Optional quiet

    quiet?: boolean

    If true, disables printing informational and warning messages to the console when +

    Optional quiet

    quiet?: boolean

    If true, disables printing informational and warning messages to the console when packaging the application. This does not disable errors.

    Defaults to false.

    -

    Optional tmpdir

    tmpdir?: string | false

    The base directory to use as a temporary directory. Set to false to disable use of a +

    Optional tmpdir

    tmpdir?: string | false

    The base directory to use as a temporary directory. Set to false to disable use of a temporary directory. Defaults to the system's temporary directory.

    -

    Windows

    Optional win32metadata

    win32metadata?: Win32MetadataOptions

    Application metadata to embed into the Windows executable.

    -

    Optional windowsSign

    windowsSign?: true | WindowsSignOptions

    If present, signs Windows binary files. +

    Windows

    Optional win32metadata

    win32metadata?: Win32MetadataOptions

    Application metadata to embed into the Windows executable.

    +

    Optional windowsSign

    windowsSign?: true | WindowsSignOptions

    If present, signs Windows binary files. When the value is true, pass default configuration to the signing module. See @electron/windows-sign for sub-option descriptions and their defaults.

    -

    macOS

    Optional appCategoryType

    appCategoryType?: string

    The application category type, as shown in the Finder via View → Arrange by Application +

    macOS

    Optional appCategoryType

    appCategoryType?: string

    The application category type, as shown in the Finder via View → Arrange by Application Category when viewing the Applications directory.

    For example, app-category-type=public.app-category.developer-tools will set the application category to Developer Tools.

    Valid values are listed in Apple's documentation.

    -

    Optional darwinDarkModeSupport

    darwinDarkModeSupport?: boolean

    Forces support for Mojave (macOS 10.14) dark mode in your packaged app. This sets the +

    Optional darwinDarkModeSupport

    darwinDarkModeSupport?: boolean

    Forces support for Mojave (macOS 10.14) dark mode in your packaged app. This sets the NSRequiresAquaSystemAppearance key to false in your app's Info.plist. For more information, see the Electron documentation and the Apple developer documentation.

    -

    Optional extendHelperInfo

    extendHelperInfo?: string | {
        [property: string]: any;
    }

    When the value is a string, specifies the filename of a plist file. Its contents are merged +

    Optional extendHelperInfo

    extendHelperInfo?: string | {
        [property: string]: any;
    }

    When the value is a string, specifies the filename of a plist file. Its contents are merged into all the Helper apps' Info.plist files. When the value is an Object, it specifies an already-parsed plist data structure that is merged into all the Helper apps' Info.plist files.

    @@ -253,7 +253,7 @@
  • electron or electron-nightly, but are overridden by other options such as appVersion or appBundleId.
    • -

    Type declaration

    • [property: string]: any

    Optional extendInfo

    extendInfo?: string | {
        [property: string]: any;
    }

    When the value is a string, specifies the filename of a plist file. Its contents are merged +

    Type declaration

    • [property: string]: any

    Optional extendInfo

    extendInfo?: string | {
        [property: string]: any;
    }

    When the value is a string, specifies the filename of a plist file. Its contents are merged into the app's Info.plist. When the value is an Object, it specifies an already-parsed plist data structure that is merged into the app's Info.plist.

    @@ -262,12 +262,12 @@
  • electron or electron-nightly, but are overridden by other options such as appVersion or appBundleId.
    • -

    Type declaration

    • [property: string]: any

    Optional helperBundleId

    helperBundleId?: string

    The bundle identifier to use in the application helper's Info.plist.

    -

    Optional osxNotarize

    osxNotarize?: NotaryToolCredentials

    If present, notarizes macOS target apps when the host platform is macOS and Xcode is installed. +

    Type declaration

    • [property: string]: any

    Optional helperBundleId

    helperBundleId?: string

    The bundle identifier to use in the application helper's Info.plist.

    +

    Optional osxNotarize

    osxNotarize?: NotaryToolCredentials

    If present, notarizes macOS target apps when the host platform is macOS and Xcode is installed. See @electron/notarize for option descriptions, such as how to use appleIdPassword safely or obtain an API key.

    Requires the osxSign option to be set.

    -

    Optional osxSign

    osxSign?: true | OsxSignOptions

    If present, signs macOS target apps when the host platform is macOS and Xcode is installed. +

    Optional osxSign

    osxSign?: true | OsxSignOptions

    If present, signs macOS target apps when the host platform is macOS and Xcode is installed. When the value is true, pass default configuration to the signing module. See @electron/osx-sign for sub-option descriptions and their defaults. Options include, but are not limited to:

    @@ -275,8 +275,8 @@
  • identity (string): The identity used when signing the package via codesign.
  • binaries (array): Path to additional binaries that will be signed along with built-ins of Electron/
    • -

    Optional protocols

    protocols?: MacOSProtocol[]

    The URL protocol schemes associated with the Electron app.

    -

    Optional usageDescription

    usageDescription?: {
        [property: string]: string;
    }

    Human-readable descriptions of how the Electron app uses certain macOS features. These are displayed +

    Optional protocols

    protocols?: MacOSProtocol[]

    The URL protocol schemes associated with the Electron app.

    +

    Optional usageDescription

    usageDescription?: {
        [property: string]: string;
    }

    Human-readable descriptions of how the Electron app uses certain macOS features. These are displayed in the App Store. A non-exhaustive list of available properties:

    • Camera - required for media access API usage in macOS Catalina
      • @@ -286,4 +286,4 @@ of the pattern NS(.*)UsageDescription, where the captured group is the key to use.

    Type declaration

    • [property: string]: string

    Example

    {
      usageDescription: {
        Camera: 'Needed for video calls',
        Microphone: 'Needed for voice calls'
      }
    }
    -

    Settings

    Member Visibility

    Theme

    On This Page

    dirafterAsarafterCompleteafterCopyafterCopyExtraResourcesafterExtractafterFinalizePackageTargetsafterInitializeafterPruneallappBundleIdappCopyrightappVersionarchasarbeforeAsarbeforeCopybeforeCopyExtraResourcesbuildVersionderefSymlinksdownloadelectronVersionelectronZipDirexecutableNameextraResourceiconignorejunknameosxUniversaloutoverwriteplatformprebuiltAsarprunequiettmpdirwin32metadatawindowsSignappCategoryTypedarwinDarkModeSupportextendHelperInfoextendInfohelperBundleIdosxNotarizeosxSignprotocolsusageDescription
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    dirafterAsarafterCompleteafterCopyafterCopyExtraResourcesafterExtractafterFinalizePackageTargetsafterInitializeafterPruneallappBundleIdappCopyrightappVersionarchasarbeforeAsarbeforeCopybeforeCopyExtraResourcesbuildVersionderefSymlinksdownloadelectronVersionelectronZipDirexecutableNameextraResourceiconignorejunknameosxUniversaloutoverwriteplatformprebuiltAsarprunequiettmpdirwin32metadatawindowsSignappCategoryTypedarwinDarkModeSupportextendHelperInfoextendInfohelperBundleIdosxNotarizeosxSignprotocolsusageDescription
    \ No newline at end of file diff --git a/main/interfaces/OsxSignOptions.html b/main/interfaces/OsxSignOptions.html index e526f159..b02b5131 100644 --- a/main/interfaces/OsxSignOptions.html +++ b/main/interfaces/OsxSignOptions.html @@ -1,5 +1,5 @@ OsxSignOptions | @electron/packager

    Interface OsxSignOptions

    See the documentation for @electron/osx-sign for details.

    -
    interface OsxSignOptions {
        identity?: string;
        identityValidation?: boolean;
        ignore?: string | string[] | ((file) => boolean);
        keychain?: string;
        optionsForFile?: ((filePath) => PerFileSignOptions);
        preAutoEntitlements?: boolean;
        preEmbedProvisioningProfile?: boolean;
        provisioningProfile?: string;
        strictVerify?: boolean;
        type?: SigningDistributionType;
    }

    Properties

    identity? +
    interface OsxSignOptions {
        identity?: string;
        identityValidation?: boolean;
        ignore?: string | string[] | ((file) => boolean);
        keychain?: string;
        optionsForFile?: ((filePath) => PerFileSignOptions);
        preAutoEntitlements?: boolean;
        preEmbedProvisioningProfile?: boolean;
        provisioningProfile?: string;
        strictVerify?: boolean;
        type?: SigningDistributionType;
    }

    Properties

    identity? identityValidation? ignore? keychain? diff --git a/main/interfaces/OsxUniversalOptions.html b/main/interfaces/OsxUniversalOptions.html index 4504e291..3ea3998b 100644 --- a/main/interfaces/OsxUniversalOptions.html +++ b/main/interfaces/OsxUniversalOptions.html @@ -1,6 +1,6 @@ OsxUniversalOptions | @electron/packager

    Interface OsxUniversalOptions

    See the documentation for @electron/universal for details.

    -
    interface OsxUniversalOptions {
        infoPlistsToIgnore?: string;
        mergeASARs?: boolean;
        singleArchFiles?: string;
        x64ArchFiles?: string;
    }

    Properties

    infoPlistsToIgnore? +
    interface OsxUniversalOptions {
        infoPlistsToIgnore?: string;
        mergeASARs?: boolean;
        singleArchFiles?: string;
        x64ArchFiles?: string;
    }

    Properties

    infoPlistsToIgnore? mergeASARs? singleArchFiles? x64ArchFiles? diff --git a/main/interfaces/Win32MetadataOptions.html b/main/interfaces/Win32MetadataOptions.html index 4c6885e2..d94eb4c5 100644 --- a/main/interfaces/Win32MetadataOptions.html +++ b/main/interfaces/Win32MetadataOptions.html @@ -1,5 +1,5 @@ Win32MetadataOptions | @electron/packager

    Interface Win32MetadataOptions

    A collection of application metadata to embed into the Windows executable.

    -
    interface Win32MetadataOptions {
        CompanyName?: string;
        FileDescription?: string;
        InternalName?: string;
        OriginalFilename?: string;
        ProductName?: string;
        application-manifest?: string;
        requested-execution-level?: "asInvoker" | "highestAvailable" | "requireAdministrator";
    }

    Properties

    CompanyName? +
    interface Win32MetadataOptions {
        CompanyName?: string;
        FileDescription?: string;
        InternalName?: string;
        OriginalFilename?: string;
        ProductName?: string;
        application-manifest?: string;
        requested-execution-level?: "asInvoker" | "highestAvailable" | "requireAdministrator";
    }

    Properties

    CompanyName? FileDescription? InternalName? OriginalFilename? @@ -7,11 +7,11 @@ application-manifest? requested-execution-level?

    Properties

    Optional CompanyName

    CompanyName?: string

    Defaults to the author name from the nearest package.json.

    -

    Optional FileDescription

    FileDescription?: string

    Defaults to either productName or name from the nearest package.json.

    -

    Optional InternalName

    InternalName?: string

    Defaults to either productName or name from the nearest package.json.

    -

    Optional OriginalFilename

    OriginalFilename?: string

    Defaults to the renamed Electron .exe file.

    -

    Optional ProductName

    ProductName?: string

    Defaults to either productName or name from the nearest package.json.

    -

    Optional application-manifest

    application-manifest?: string

    Path to a local manifest file.

    +

    Optional FileDescription

    FileDescription?: string

    Defaults to either productName or name from the nearest package.json.

    +

    Optional InternalName

    InternalName?: string

    Defaults to either productName or name from the nearest package.json.

    +

    Optional OriginalFilename

    OriginalFilename?: string

    Defaults to the renamed Electron .exe file.

    +

    Optional ProductName

    ProductName?: string

    Defaults to either productName or name from the nearest package.json.

    +

    Optional application-manifest

    application-manifest?: string

    Path to a local manifest file.

    See MSDN for more details.

    -

    Optional requested-execution-level

    requested-execution-level?: "asInvoker" | "highestAvailable" | "requireAdministrator"

    See MSDN for details.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    CompanyNameFileDescriptionInternalNameOriginalFilenameProductNameapplication-manifestrequested-execution-level
    \ No newline at end of file +

    Optional requested-execution-level

    requested-execution-level?: "asInvoker" | "highestAvailable" | "requireAdministrator"

    See MSDN for details.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    CompanyNameFileDescriptionInternalNameOriginalFilenameProductNameapplication-manifestrequested-execution-level
    \ No newline at end of file diff --git a/main/interfaces/WindowsSignOptions.html b/main/interfaces/WindowsSignOptions.html index f7d85622..c08ebdd1 100644 --- a/main/interfaces/WindowsSignOptions.html +++ b/main/interfaces/WindowsSignOptions.html @@ -1,6 +1,6 @@ WindowsSignOptions | @electron/packager

    Interface WindowsSignOptions

    See the documentation for @electron/windows-sign for details.

    -
    interface WindowsSignOptions {
        automaticallySelectCertificate?: boolean;
        certificateFile?: string;
        certificatePassword?: string;
        continueOnError?: boolean;
        debug?: boolean;
        description?: string;
        hookFunction?: HookFunction;
        hookModulePath?: string;
        signJavaScript?: boolean;
        signToolPath?: string;
        signWithParams?: string | string[];
        timestampServer?: string;
        website?: string;
    }

    Hierarchy

    • Omit<WindowsInternalSignOptions, "appDirectory">
      • WindowsSignOptions

    Properties

    automaticallySelectCertificate? +
    interface WindowsSignOptions {
        automaticallySelectCertificate?: boolean;
        certificateFile?: string;
        certificatePassword?: string;
        continueOnError?: boolean;
        debug?: boolean;
        description?: string;
        hookFunction?: HookFunction;
        hookModulePath?: string;
        signJavaScript?: boolean;
        signToolPath?: string;
        signWithParams?: string | string[];
        timestampServer?: string;
        website?: string;
    }

    Hierarchy

    • Omit<WindowsInternalSignOptions, "appDirectory">
      • WindowsSignOptions

    Properties

    automaticallySelectCertificate? certificateFile? certificatePassword? continueOnError? @@ -21,7 +21,7 @@

    Optional certificatePassword

    certificatePassword?: string

    Password to certificateFile. If you don't provide this, you need to provide the signWithParams option. Will use process.env.WINDOWS_CERTIFICATE_PASSWORD if this option is not provided.

    -

    Optional continueOnError

    continueOnError?: boolean

    Optional debug

    debug?: boolean

    Enables debug logging.

    +

    Optional continueOnError

    continueOnError?: boolean

    Optional debug

    debug?: boolean

    Enables debug logging.

    Default Value

    false

    Optional description

    description?: string

    Description of the signed content. Will be passed to signtool.exe as /d.

    diff --git a/main/types/ArchOption.html b/main/types/ArchOption.html index 581acf3c..4a63a763 100644 --- a/main/types/ArchOption.html +++ b/main/types/ArchOption.html @@ -1 +1 @@ -ArchOption | @electron/packager

    Type alias ArchOption

    ArchOption: TargetArch | "all"

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +ArchOption | @electron/packager

    Type alias ArchOption

    ArchOption: TargetArch | "all"

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/main/types/FinalizePackageTargetsHookFunction.html b/main/types/FinalizePackageTargetsHookFunction.html index 395866d1..e1921875 100644 --- a/main/types/FinalizePackageTargetsHookFunction.html +++ b/main/types/FinalizePackageTargetsHookFunction.html @@ -1 +1 @@ -FinalizePackageTargetsHookFunction | @electron/packager

    Type alias FinalizePackageTargetsHookFunction

    FinalizePackageTargetsHookFunction: ((targets, callback) => void)

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +FinalizePackageTargetsHookFunction | @electron/packager

    Type alias FinalizePackageTargetsHookFunction

    FinalizePackageTargetsHookFunction: ((targets, callback) => void)

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/main/types/HookFunction.html b/main/types/HookFunction.html index 75339926..f324e609 100644 --- a/main/types/HookFunction.html +++ b/main/types/HookFunction.html @@ -15,4 +15,4 @@

    For real-world examples of HookFunctions, see the list of related plugins.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/main/types/HookFunctionErrorCallback.html b/main/types/HookFunctionErrorCallback.html index f35db024..8de03977 100644 --- a/main/types/HookFunctionErrorCallback.html +++ b/main/types/HookFunctionErrorCallback.html @@ -1 +1 @@ -HookFunctionErrorCallback | @electron/packager

    Type alias HookFunctionErrorCallback

    HookFunctionErrorCallback: ((err?) => void)

    Type declaration

      • (err?): void

      • Parameters

        • Optional err: Error | null

        Returns void

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +HookFunctionErrorCallback | @electron/packager

    Type alias HookFunctionErrorCallback

    HookFunctionErrorCallback: ((err?) => void)

    Type declaration

      • (err?): void

      • Parameters

        • Optional err: Error | null

        Returns void

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/main/types/IgnoreFunction.html b/main/types/IgnoreFunction.html index c153e9c7..54fa33aa 100644 --- a/main/types/IgnoreFunction.html +++ b/main/types/IgnoreFunction.html @@ -1,4 +1,4 @@ IgnoreFunction | @electron/packager

    Type alias IgnoreFunction

    IgnoreFunction: ((path) => boolean)

    A predicate function that, given an absolute file path, returns true if the file should be ignored, or false if the file should be kept. This does not use any of the default ignored files/directories listed for the ignore option.

    -

    Type declaration

      • (path): boolean

      • Parameters

        • path: string

        Returns boolean

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

      • (path): boolean

      • Parameters

        • path: string

        Returns boolean

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/main/types/OfficialArch.html b/main/types/OfficialArch.html index 4650ee05..1ff5eff3 100644 --- a/main/types/OfficialArch.html +++ b/main/types/OfficialArch.html @@ -1,3 +1,3 @@ OfficialArch | @electron/packager

    Type alias OfficialArch

    OfficialArch: "ia32" | "x64" | "armv7l" | "arm64" | "mips64el" | "universal"

    Architectures that have been supported by the official Electron prebuilt binaries, past and present.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/main/types/OfficialPlatform.html b/main/types/OfficialPlatform.html index a1d409ef..39efbeee 100644 --- a/main/types/OfficialPlatform.html +++ b/main/types/OfficialPlatform.html @@ -1,2 +1,2 @@ OfficialPlatform | @electron/packager

    Type alias OfficialPlatform

    OfficialPlatform: "linux" | "win32" | "darwin" | "mas"

    Platforms that have been supported by the official Electron prebuilt binaries, past and present.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/main/types/PlatformOption.html b/main/types/PlatformOption.html index 82346a31..78c2ca3e 100644 --- a/main/types/PlatformOption.html +++ b/main/types/PlatformOption.html @@ -1 +1 @@ -PlatformOption | @electron/packager

    Type alias PlatformOption

    PlatformOption: TargetPlatform | "all"

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +PlatformOption | @electron/packager

    Type alias PlatformOption

    PlatformOption: TargetPlatform | "all"

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/main/types/SupportedArch.html b/main/types/SupportedArch.html index 767f2e60..3cd906dc 100644 --- a/main/types/SupportedArch.html +++ b/main/types/SupportedArch.html @@ -1,3 +1,3 @@ SupportedArch | @electron/packager

    Type alias SupportedArch

    SupportedArch: OfficialArch | "all"

    Architecture values that we actually support out of the box (not considering unofficial values provided in download.mirrorOptions).

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/main/types/SupportedPlatform.html b/main/types/SupportedPlatform.html index 8193338e..0af271d3 100644 --- a/main/types/SupportedPlatform.html +++ b/main/types/SupportedPlatform.html @@ -1,3 +1,3 @@ SupportedPlatform | @electron/packager

    Type alias SupportedPlatform

    SupportedPlatform: OfficialPlatform | "all"

    Platform values that we actually support out of the box (not considering unofficial values provided in download.mirrorOptions).

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/main/types/TargetArch.html b/main/types/TargetArch.html index b8b03cd6..522c6f37 100644 --- a/main/types/TargetArch.html +++ b/main/types/TargetArch.html @@ -1 +1 @@ -TargetArch | @electron/packager

    Type alias TargetArch

    TargetArch: OfficialArch | string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +TargetArch | @electron/packager

    Type alias TargetArch

    TargetArch: OfficialArch | string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/main/types/TargetDefinition.html b/main/types/TargetDefinition.html index 8fbd1d3f..5373ffdd 100644 --- a/main/types/TargetDefinition.html +++ b/main/types/TargetDefinition.html @@ -1 +1 @@ -TargetDefinition | @electron/packager

    Type alias TargetDefinition

    TargetDefinition: {
        arch: TargetArch;
        platform: TargetPlatform;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +TargetDefinition | @electron/packager

    Type alias TargetDefinition

    TargetDefinition: {
        arch: TargetArch;
        platform: TargetPlatform;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/main/types/TargetPlatform.html b/main/types/TargetPlatform.html index b3cbeb06..a6a63d87 100644 --- a/main/types/TargetPlatform.html +++ b/main/types/TargetPlatform.html @@ -1 +1 @@ -TargetPlatform | @electron/packager

    Type alias TargetPlatform

    TargetPlatform: OfficialPlatform | string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +TargetPlatform | @electron/packager

    Type alias TargetPlatform

    TargetPlatform: OfficialPlatform | string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file