跳到内容

app builder lib.Class.MacPackager

Electron-Builder / app-builder-lib / MacPackager

继承自

构造函数

new MacPackager()

new MacPackager(info): MacPackager

参数

info: Packager

返回值

MacPackager

覆盖

PlatformPackager.constructor

属性

appInfo

readonly appInfo: AppInfo

继承自

PlatformPackager.appInfo


codeSigningInfo

readonly codeSigningInfo: MemoLazy<null | CreateKeychainOptions, CodeSigningInfo>


info

readonly info: Packager

继承自

PlatformPackager.info


platform

readonly platform: Platform

继承自

PlatformPackager.platform


platformSpecificBuildOptions

readonly platformSpecificBuildOptions: MacConfiguration

继承自

PlatformPackager.platformSpecificBuildOptions

访问器

buildResourcesDir

get buildResourcesDir(): string

返回值

string

继承自

PlatformPackager.buildResourcesDir


compression

get compression(): CompressionLevel

返回值

CompressionLevel

继承自

PlatformPackager.compression


config

get config(): Configuration

返回值

Configuration

继承自

PlatformPackager.config


debugLogger

get debugLogger(): DebugLogger

返回值

DebugLogger

继承自

PlatformPackager.debugLogger


defaultTarget

get defaultTarget(): string[]

返回值

string[]

覆盖

PlatformPackager.defaultTarget


fileAssociations

get fileAssociations(): FileAssociation[]

返回值

FileAssociation[]

继承自

PlatformPackager.fileAssociations


forceCodeSigning

get forceCodeSigning(): boolean

返回值

boolean

继承自

PlatformPackager.forceCodeSigning


packagerOptions

get packagerOptions(): PackagerOptions

返回值

PackagerOptions

继承自

PlatformPackager.packagerOptions


projectDir

get projectDir(): string

返回值

string

继承自

PlatformPackager.projectDir


resourceList

get resourceList(): Promise<string[]>

返回值

Promise<string[]>

继承自

PlatformPackager.resourceList

方法

addElectronFuses()

addElectronFuses(context, fuses): Promise<number>

在此处使用 AfterPackContext 以保持公共 API 可用

参数

context: PackContext

fuses: FuseConfig

可以在 afterPack 钩子中使用,用于自定义熔断逻辑,如下所示。如果有人想要覆盖 electron-builder 的 @electron/fuses 版本,这是一种替代方法

await context.packager.addElectronFuses(context, { ... })

返回值

Promise<number>

继承自

PlatformPackager.addElectronFuses


applyCommonInfo()

applyCommonInfo(appPlist, contentsPath): Promise<void>

参数

appPlist: any

contentsPath: string

返回值

Promise<void>


artifactPatternConfig()

artifactPatternConfig(targetSpecificOptions, defaultPattern): object

参数

targetSpecificOptions: TargetSpecificOptions | Nullish

defaultPattern: undefined | string

返回值

object

isUserForced

isUserForced: boolean = !!userSpecifiedPattern

pattern

pattern: string

继承自

PlatformPackager.artifactPatternConfig


computeAppOutDir()

protected computeAppOutDir(outDir, arch): string

参数

outDir: string

arch: Arch

返回值

string

继承自

PlatformPackager.computeAppOutDir


computeSafeArtifactName()

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

参数

suggestedName: null | string

ext: string

arch?: null | Arch

skipDefaultArch?: boolean = true

defaultArch?: string

safePattern?: string = "${name}-${version}-${arch}.${ext}"

返回值

null | string

继承自

PlatformPackager.computeSafeArtifactName


createGetFileMatchersOptions()

createGetFileMatchersOptions(outDir, arch, customBuildOptions): GetFileMatchersOptions

参数

outDir: string

arch: Arch

customBuildOptions: PlatformSpecificBuildOptions

返回值

GetFileMatchersOptions

继承自

PlatformPackager.createGetFileMatchersOptions


createTargets()

createTargets(targets, mapper): void

参数

targets: string[]

mapper

返回值

void

覆盖

PlatformPackager.createTargets


createTransformerForExtraFiles()

protected createTransformerForExtraFiles(packContext): null | FileTransformer

参数

packContext: PackContext

返回值

null | FileTransformer

继承自

PlatformPackager.createTransformerForExtraFiles


dispatchArtifactCreated()

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

参数

file: string

target: null | Target

arch: null | Arch

safeArtifactName?: null | string

返回值

Promise<void>

继承自

PlatformPackager.dispatchArtifactCreated


doAddElectronFuses()

protected doAddElectronFuses(packContext): Promise<void>

参数

packContext: PackContext

返回值

Promise<void>

继承自

PlatformPackager.doAddElectronFuses


doFlat()

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

参数

appPath: string

outFile: string

identity: Identity

keychain: string | Nullish

返回值

Promise<any>


doGetCscPassword()

doGetCscPassword(): string | Nullish

返回值

string | Nullish

继承自

PlatformPackager.doGetCscPassword


doPack()

protected doPack(config): Promise<any>

参数

config: DoPackOptions<MacConfiguration>

返回值

Promise<any>

覆盖

PlatformPackager.doPack


doSign()

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

参数

opts: SignOptions

customSignOptions: MacConfiguration

identity: null | Identity

返回值

Promise<void>


doSignAfterPack()

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

参数

outDir: string

appOutDir: string

platformName: ElectronPlatformName

arch: Arch

platformSpecificBuildOptions: MacConfiguration

targets: Target[]

返回值

Promise<void>

继承自

PlatformPackager.doSignAfterPack


expandArtifactBeautyNamePattern()

expandArtifactBeautyNamePattern(targetSpecificOptions, ext, arch?): string

参数

targetSpecificOptions: TargetSpecificOptions | Nullish

ext: string

arch?: null | Arch

返回值

string

继承自

PlatformPackager.expandArtifactBeautyNamePattern


expandArtifactNamePattern()

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

参数

targetSpecificOptions: TargetSpecificOptions | Nullish

ext: string

arch?: null | Arch

defaultPattern?: string

skipDefaultArch?: boolean = true

defaultArch?: string

返回值

string

继承自

PlatformPackager.expandArtifactNamePattern


expandMacro()

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

参数

pattern: string

arch?: null | string

extra?: any = {}

isProductNameSanitized?: boolean = true

返回值

string

继承自

PlatformPackager.expandMacro


generateName2()

generateName2(ext, classifier, deployment): string

参数

ext: null | string

classifier: string | Nullish

deployment: boolean

返回值

string

继承自

PlatformPackager.generateName2


getCscLink(extraEnvName?): string | Nullish

参数

extraEnvName?: null | string

返回值

string | Nullish

继承自

PlatformPackager.getCscLink


getCscPassword()

getCscPassword(): string

返回值

string

继承自

PlatformPackager.getCscPassword


getDefaultFrameworkIcon()

getDefaultFrameworkIcon(): null | string

返回值

null | string

继承自

PlatformPackager.getDefaultFrameworkIcon


getElectronDestinationDir()

getElectronDestinationDir(appOutDir): string

参数

appOutDir: string

返回值

string

覆盖

PlatformPackager.getElectronDestinationDir


getElectronSrcDir()

getElectronSrcDir(dist): string

参数

dist: string

返回值

string

覆盖

PlatformPackager.getElectronSrcDir


getIconPath()

getIconPath(): Promise<null | string>

返回值

Promise<null | string>

覆盖

PlatformPackager.getIconPath


getMacOsResourcesDir()

getMacOsResourcesDir(appOutDir): string

参数

appOutDir: string

返回值

string

继承自

PlatformPackager.getMacOsResourcesDir


getOrConvertIcon()

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

参数

format: IconFormat

返回值

Promise<null | string>

继承自

PlatformPackager.getOrConvertIcon


getResource()

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

参数

custom: string | Nullish

• …names: string[]

返回值

Promise<null | string>

继承自

PlatformPackager.getResource


getResourcesDir()

getResourcesDir(appOutDir): string

参数

appOutDir: string

返回值

string

继承自

PlatformPackager.getResourcesDir


getTempFile()

getTempFile(suffix): Promise<string>

参数

suffix: string

返回值

Promise<string>

继承自

PlatformPackager.getTempFile


notarizeIfProvided()

notarizeIfProvided(appPath): Promise<void>

参数

appPath: string

返回值

Promise<void>


pack()

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

参数

outDir: string

arch: Arch

targets: Target[]

taskManager: AsyncTaskManager

返回值

Promise<void>

覆盖

PlatformPackager.pack


packageInDistributableFormat()

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

参数

appOutDir: string

arch: Arch

targets: Target[]

taskManager: AsyncTaskManager

返回值

void

继承自

PlatformPackager.packageInDistributableFormat


prepareAppInfo()

protected prepareAppInfo(appInfo): AppInfo

参数

appInfo: AppInfo

返回值

AppInfo

覆盖

PlatformPackager.prepareAppInfo


resolveIcon()

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

参数

sources: string[]

fallbackSources: string[]

outputFormat: IconFormat

返回值

Promise<IconInfo[]>

继承自

PlatformPackager.resolveIcon


signApp()

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

参数

packContext: PackContext

isAsar: boolean

返回值

Promise<boolean>

覆盖自

PlatformPackager.signApp