app builder lib.Class.PlatformPackager

Electron-Builder / app-builder-lib / PlatformPackager

继承自¶

类型参数¶

• DC extends PlatformSpecificBuildOptions

构造函数¶

new PlatformPackager()¶

protected new PlatformPackager<DC>(info, platform): PlatformPackager<DC>

参数¶

• info: Packager

• platform: Platform

返回值¶

PlatformPackager<DC>

属性¶

appInfo¶

readonly appInfo: AppInfo

info¶

readonly info: Packager

platform¶

readonly platform: Platform

platformSpecificBuildOptions¶

readonly platformSpecificBuildOptions: DC

访问器¶

buildResourcesDir¶

get buildResourcesDir(): string

返回值¶

string

compression¶

get compression(): CompressionLevel

返回值¶

CompressionLevel

config¶

get config(): Configuration

返回值¶

Configuration

debugLogger¶

get debugLogger(): DebugLogger

返回值¶

DebugLogger

defaultTarget¶

get abstract defaultTarget(): string[]

返回值¶

string[]

fileAssociations¶

get fileAssociations(): FileAssociation[]

返回值¶

FileAssociation[]

forceCodeSigning¶

get forceCodeSigning(): boolean

返回值¶

boolean

packagerOptions¶

get packagerOptions(): PackagerOptions

返回值¶

PackagerOptions

projectDir¶

get projectDir(): string

返回值¶

string

resourceList¶

get resourceList(): Promise<string[]>

返回值¶

Promise<string[]>

方法¶

addElectronFuses()¶

addElectronFuses(context, fuses): Promise<number>

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

参数¶

• context: PackContext

• fuses: FuseConfig

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

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

返回值¶

Promise<number>

artifactPatternConfig()¶

artifactPatternConfig(targetSpecificOptions, defaultPattern): object

参数¶

• targetSpecificOptions: TargetSpecificOptions | Nullish

• defaultPattern: undefined | string

返回值¶

object

isUserForced¶

isUserForced: boolean = !!userSpecifiedPattern

pattern¶

pattern: string

computeAppOutDir()¶

protected computeAppOutDir(outDir, arch): string

参数¶

• outDir: string

• arch: Arch

返回值¶

string

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

createGetFileMatchersOptions()¶

createGetFileMatchersOptions(outDir, arch, customBuildOptions): GetFileMatchersOptions

参数¶

• outDir: string

• arch: Arch

• customBuildOptions: PlatformSpecificBuildOptions

返回值¶

GetFileMatchersOptions

createTargets()¶

abstract createTargets(targets, mapper): void

参数¶

• targets: string[]

• mapper

返回值¶

void

createTransformerForExtraFiles()¶

protected createTransformerForExtraFiles(packContext): null | FileTransformer

参数¶

• packContext: PackContext

返回值¶

null | FileTransformer

dispatchArtifactCreated()¶

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

参数¶

• file: string

• target: null | Target

• arch: null | Arch

• safeArtifactName?: null | string

返回值¶

Promise<void>

doAddElectronFuses()¶

protected doAddElectronFuses(packContext): Promise<void>

参数¶

• packContext: PackContext

返回值¶

Promise<void>

doGetCscPassword()¶

doGetCscPassword(): string | Nullish

返回值¶

string | Nullish

doPack()¶

protected doPack(packOptions): Promise<void>

参数¶

• packOptions: DoPackOptions<DC>

返回值¶

Promise<void>

doSignAfterPack()¶

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

参数¶

• outDir: string

• appOutDir: string

• platformName: ElectronPlatformName

• arch: Arch

• platformSpecificBuildOptions: DC

• targets: Target[]

返回值¶

Promise<void>

expandArtifactBeautyNamePattern()¶

expandArtifactBeautyNamePattern(targetSpecificOptions, ext, arch?): string

参数¶

• targetSpecificOptions: TargetSpecificOptions | Nullish

• ext: string

• arch?: null | Arch

返回值¶

string

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

expandMacro()¶

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

参数¶

• pattern: string

• arch?: null | string

• extra?: any = {}

• isProductNameSanitized?: boolean = true

返回值¶

string

generateName2()¶

generateName2(ext, classifier, deployment): string

参数¶

• ext: null | string

• classifier: string | Nullish

• deployment: boolean

返回值¶

string

getCscLink()¶

getCscLink(extraEnvName?): string | Nullish

参数¶

• extraEnvName?: null | string

返回值¶

string | Nullish

getCscPassword()¶

getCscPassword(): string

返回值¶

string

getDefaultFrameworkIcon()¶

getDefaultFrameworkIcon(): null | string

返回值¶

null | string

getElectronDestinationDir()¶

getElectronDestinationDir(appOutDir): string

参数¶

• appOutDir: string

返回值¶

string

getElectronSrcDir()¶

getElectronSrcDir(dist): string

参数¶

• dist: string

返回值¶

string

getIconPath()¶

getIconPath(): Promise<null | string>

返回值¶

Promise<null | string>

getMacOsResourcesDir()¶

getMacOsResourcesDir(appOutDir): string

参数¶

• appOutDir: string

返回值¶

string

getOrConvertIcon()¶

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

参数¶

• format: IconFormat

返回值¶

Promise<null | string>

getResource()¶

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

参数¶

• custom: string | Nullish

• …names: string[]

返回值¶

Promise<null | string>

getResourcesDir()¶

getResourcesDir(appOutDir): string

参数¶

• appOutDir: string

返回值¶

string

getTempFile()¶

getTempFile(suffix): Promise<string>

参数¶

• suffix: string

返回值¶

Promise<string>

pack()¶

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

参数¶

• outDir: string

• arch: Arch

• targets: Target[]

• taskManager: AsyncTaskManager

返回值¶

Promise<any>

packageInDistributableFormat()¶

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

参数¶

• appOutDir: string

• arch: Arch

• targets: Target[]

• taskManager: AsyncTaskManager

返回值¶

void

prepareAppInfo()¶

protected prepareAppInfo(appInfo): AppInfo

参数¶

• appInfo: AppInfo

返回值¶

AppInfo

resolveIcon()¶

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

参数¶

• sources: string[]

• fallbackSources: string[]

• outputFormat: IconFormat

返回值¶

Promise<IconInfo[]>

signApp()¶

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

参数¶

• packContext: PackContext

• isAsar: boolean

返回值¶

Promise<boolean>