electron builder.Class.MacPackager

Electron-Builder / electron-builder / MacPackager

Extends¶

PlatformPackager<MacConfiguration>

Constructors¶

new MacPackager()¶

new MacPackager(info): MacPackager

Parameters¶

• info: Packager

Returns¶

MacPackager

Overrides¶

PlatformPackager.constructor

Properties¶

appInfo¶

readonly appInfo: AppInfo

Inherited from¶

PlatformPackager.appInfo

codeSigningInfo¶

readonly codeSigningInfo: MemoLazy<null | CreateKeychainOptions, CodeSigningInfo>

info¶

readonly info: Packager

Inherited from¶

PlatformPackager.info

platform¶

readonly platform: Platform

Inherited from¶

PlatformPackager.platform

platformSpecificBuildOptions¶

readonly platformSpecificBuildOptions: MacConfiguration

Inherited from¶

PlatformPackager.platformSpecificBuildOptions

Accessors¶

buildResourcesDir¶

get buildResourcesDir(): string

Returns¶

string

Inherited from¶

PlatformPackager.buildResourcesDir

compression¶

get compression(): CompressionLevel

Returns¶

CompressionLevel

Inherited from¶

PlatformPackager.compression

config¶

get config(): Configuration

Returns¶

Configuration

Inherited from¶

PlatformPackager.config

debugLogger¶

get debugLogger(): DebugLogger

Returns¶

DebugLogger

Inherited from¶

PlatformPackager.debugLogger

defaultTarget¶

get defaultTarget(): string[]

Returns¶

string[]

Overrides¶

PlatformPackager.defaultTarget

fileAssociations¶

get fileAssociations(): FileAssociation[]

Returns¶

FileAssociation[]

Inherited from¶

PlatformPackager.fileAssociations

forceCodeSigning¶

get forceCodeSigning(): boolean

Returns¶

boolean

Inherited from¶

PlatformPackager.forceCodeSigning

packagerOptions¶

get packagerOptions(): PackagerOptions

Returns¶

PackagerOptions

Inherited from¶

PlatformPackager.packagerOptions

projectDir¶

get projectDir(): string

Returns¶

string

Inherited from¶

PlatformPackager.projectDir

resourceList¶

get resourceList(): Promise<string[]>

Returns¶

Promise<string[]>

Inherited from¶

PlatformPackager.resourceList

Methods¶

applyCommonInfo()¶

applyCommonInfo(appPlist, contentsPath): Promise<void>

Parameters¶

• appPlist: any

• contentsPath: string

Returns¶

Promise<void>

artifactPatternConfig()¶

artifactPatternConfig(targetSpecificOptions, defaultPattern): object

Parameters¶

• targetSpecificOptions: undefined | null | TargetSpecificOptions

• defaultPattern: undefined | string

Returns¶

object

isUserForced¶

isUserForced: boolean

pattern¶

pattern: string

Inherited from¶

PlatformPackager.artifactPatternConfig

computeAppOutDir()¶

protected computeAppOutDir(outDir, arch): string

Parameters¶

• outDir: string

• arch: Arch

Returns¶

string

Inherited from¶

PlatformPackager.computeAppOutDir

computeSafeArtifactName()¶

computeSafeArtifactName(suggestedName, ext, arch?, skipDefaultArch?, defaultArch?, safePattern?): null | string

Parameters¶

• suggestedName: null | string

• ext: string

• arch?: null | Arch

• skipDefaultArch?: boolean

• defaultArch?: string

• safePattern?: string

Returns¶

null | string

Inherited from¶

PlatformPackager.computeSafeArtifactName

createGetFileMatchersOptions()¶

createGetFileMatchersOptions(outDir, arch, customBuildOptions): GetFileMatchersOptions

Parameters¶

• outDir: string

• arch: Arch

• customBuildOptions: PlatformSpecificBuildOptions

Returns¶

GetFileMatchersOptions

Inherited from¶

PlatformPackager.createGetFileMatchersOptions

createTargets()¶

createTargets(targets, mapper): void

Parameters¶

• targets: string[]

• mapper

Returns¶

void

Overrides¶

PlatformPackager.createTargets

createTransformerForExtraFiles()¶

protected createTransformerForExtraFiles(packContext): null | FileTransformer

Parameters¶

• packContext: PackContext

Returns¶

null | FileTransformer

Inherited from¶

PlatformPackager.createTransformerForExtraFiles

dispatchArtifactCreated()¶

dispatchArtifactCreated(file, target, arch, safeArtifactName?): Promise<void>

Parameters¶

• file: string

• target: null | Target

• arch: null | Arch

• safeArtifactName?: null | string

Returns¶

Promise<void>

Inherited from¶

PlatformPackager.dispatchArtifactCreated

doFlat()¶

protected doFlat(appPath, outFile, identity, keychain): Promise<any>

Parameters¶

• appPath: string

• outFile: string

• identity: Identity

• keychain: undefined | null | string

Returns¶

Promise<any>

doGetCscPassword()¶

doGetCscPassword(): undefined | null | string

Returns¶

undefined | null | string

Inherited from¶

PlatformPackager.doGetCscPassword

doPack()¶

protected doPack(outDir, appOutDir, platformName, arch, platformSpecificBuildOptions, targets): Promise<any>

Parameters¶

• outDir: string

• appOutDir: string

• platformName: ElectronPlatformName

• arch: Arch

• platformSpecificBuildOptions: MacConfiguration

• targets: Target[]

Returns¶

Promise<any>

Overrides¶

PlatformPackager.doPack

doSign()¶

protected doSign(opts, customSignOptions): Promise<void>

Parameters¶

• opts: SignOptions

• customSignOptions: MacConfiguration

Returns¶

Promise<void>

doSignAfterPack()¶

protected doSignAfterPack(outDir, appOutDir, platformName, arch, platformSpecificBuildOptions, targets): Promise<void>

Parameters¶

• outDir: string

• appOutDir: string

• platformName: ElectronPlatformName

• arch: Arch

• platformSpecificBuildOptions: MacConfiguration

• targets: Target[]

Returns¶

Promise<void>

Inherited from¶

PlatformPackager.doSignAfterPack

expandArtifactBeautyNamePattern()¶

expandArtifactBeautyNamePattern(targetSpecificOptions, ext, arch?): string

Parameters¶

• targetSpecificOptions: undefined | null | TargetSpecificOptions

• ext: string

• arch?: null | Arch

Returns¶

string

Inherited from¶

PlatformPackager.expandArtifactBeautyNamePattern

expandArtifactNamePattern()¶

expandArtifactNamePattern(targetSpecificOptions, ext, arch?, defaultPattern?, skipDefaultArch?, defaultArch?): string

Parameters¶

• targetSpecificOptions: undefined | null | TargetSpecificOptions

• ext: string

• arch?: null | Arch

• defaultPattern?: string

• skipDefaultArch?: boolean

• defaultArch?: string

Returns¶

string

Inherited from¶

PlatformPackager.expandArtifactNamePattern

expandMacro()¶

expandMacro(pattern, arch?, extra?, isProductNameSanitized?): string

Parameters¶

• pattern: string

• arch?: null | string

• extra?: any

• isProductNameSanitized?: boolean

Returns¶

string

Inherited from¶

PlatformPackager.expandMacro

generateName2()¶

generateName2(ext, classifier, deployment): string

Parameters¶

• ext: null | string

• classifier: undefined | null | string

• deployment: boolean

Returns¶

string

Inherited from¶

PlatformPackager.generateName2

getCscLink()¶

getCscLink(extraEnvName?): undefined | null | string

Parameters¶

• extraEnvName?: null | string

Returns¶

undefined | null | string

Inherited from¶

PlatformPackager.getCscLink

getCscPassword()¶

getCscPassword(): string

Returns¶

string

Inherited from¶

PlatformPackager.getCscPassword

getDefaultFrameworkIcon()¶

getDefaultFrameworkIcon(): null | string

Returns¶

null | string

Inherited from¶

PlatformPackager.getDefaultFrameworkIcon

getElectronDestinationDir()¶

getElectronDestinationDir(appOutDir): string

Parameters¶

• appOutDir: string

Returns¶

string

Overrides¶

PlatformPackager.getElectronDestinationDir

getElectronSrcDir()¶

getElectronSrcDir(dist): string

Parameters¶

• dist: string

Returns¶

string

Overrides¶

PlatformPackager.getElectronSrcDir

getIconPath()¶

getIconPath(): Promise<null | string>

Returns¶

Promise<null | string>

Overrides¶

PlatformPackager.getIconPath

getMacOsResourcesDir()¶

getMacOsResourcesDir(appOutDir): string

Parameters¶

• appOutDir: string

Returns¶

string

Inherited from¶

PlatformPackager.getMacOsResourcesDir

getOrConvertIcon()¶

protected getOrConvertIcon(format): Promise<null | string>

Parameters¶

• format: IconFormat

Returns¶

Promise<null | string>

Inherited from¶

PlatformPackager.getOrConvertIcon

getResource()¶

getResource(custom, …names): Promise<null | string>

Parameters¶

• custom: undefined | null | string

• …names: string[]

Returns¶

Promise<null | string>

Inherited from¶

PlatformPackager.getResource

getResourcesDir()¶

getResourcesDir(appOutDir): string

Parameters¶

• appOutDir: string

Returns¶

string

Inherited from¶

PlatformPackager.getResourcesDir

getTempFile()¶

getTempFile(suffix): Promise<string>

Parameters¶

• suffix: string

Returns¶

Promise<string>

Inherited from¶

PlatformPackager.getTempFile

pack()¶

pack(outDir, arch, targets, taskManager): Promise<void>

Parameters¶

• outDir: string

• arch: Arch

• targets: Target[]

• taskManager: AsyncTaskManager

Returns¶

Promise<void>

Overrides¶

PlatformPackager.pack

packageInDistributableFormat()¶

protected packageInDistributableFormat(appOutDir, arch, targets, taskManager): void

Parameters¶

• appOutDir: string

• arch: Arch

• targets: Target[]

• taskManager: AsyncTaskManager

Returns¶

void

Inherited from¶

PlatformPackager.packageInDistributableFormat

prepareAppInfo()¶

protected prepareAppInfo(appInfo): AppInfo

Parameters¶

• appInfo: AppInfo

Returns¶

AppInfo

Overrides¶

PlatformPackager.prepareAppInfo

resolveIcon()¶

resolveIcon(sources, fallbackSources, outputFormat): Promise<IconInfo[]>

Parameters¶

• sources: string[]

• fallbackSources: string[]

• outputFormat: IconFormat

Returns¶

Promise<IconInfo[]>

Inherited from¶

PlatformPackager.resolveIcon

signApp()¶

protected signApp(packContext, isAsar): Promise<boolean>

Parameters¶

• packContext: PackContext

• isAsar: boolean

Returns¶

Promise<boolean>

Overrides¶

PlatformPackager.signApp