app builder lib.Class.WinPackager

Electron-Builder / app-builder-lib / WinPackager

Extends

• PlatformPackager<WindowsConfiguration>

Constructors

new WinPackager()

new WinPackager(info): WinPackager

Parameters

• info: Packager

Returns

WinPackager

Overrides

PlatformPackager.constructor

Properties

_iconPath

_iconPath: Lazy<null | string>

---

appInfo

readonly appInfo: AppInfo

Inherited from

PlatformPackager.appInfo

---

azureSignManager

readonly azureSignManager: Lazy<WindowsSignAzureManager>

---

info

readonly info: Packager

Inherited from

PlatformPackager.info

---

platform

readonly platform: Platform

Inherited from

PlatformPackager.platform

---

platformSpecificBuildOptions

readonly platformSpecificBuildOptions: WindowsConfiguration

Inherited from

PlatformPackager.platformSpecificBuildOptions

---

signtoolManager

readonly signtoolManager: Lazy<WindowsSignToolManager>

---

vm

readonly vm: Lazy<VmManager>

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

---

isForceCodeSigningVerification

get isForceCodeSigningVerification(): boolean

Returns

boolean

---

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

artifactPatternConfig()

artifactPatternConfig(targetSpecificOptions, defaultPattern): object

Parameters

• targetSpecificOptions: undefined | null | TargetSpecificOptions

• defaultPattern: undefined | string

Returns

object

isUserForced

isUserForced: boolean = !!userSpecifiedPattern

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 = true

• defaultArch?: string

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

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

Overrides

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

---

doGetCscPassword()

doGetCscPassword(): undefined | null | string

Returns

undefined | null | string

Overrides

PlatformPackager.doGetCscPassword

---

doPack()

protected doPack(outDir, appOutDir, platformName, arch, platformSpecificBuildOptions, targets, sign, disableAsarIntegrity): Promise<void>

Parameters

• outDir: string

• appOutDir: string

• platformName: ElectronPlatformName

• arch: Arch

• platformSpecificBuildOptions: WindowsConfiguration

• targets: Target[]

• sign: boolean = true

• disableAsarIntegrity: boolean = false

Returns

Promise<void>

Inherited from

PlatformPackager.doPack

---

doSignAfterPack()

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

Parameters

• outDir: string

• appOutDir: string

• platformName: ElectronPlatformName

• arch: Arch

• platformSpecificBuildOptions: WindowsConfiguration

• 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 = true

• 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 = true

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

Inherited from

PlatformPackager.getElectronDestinationDir

---

getElectronSrcDir()

getElectronSrcDir(dist): string

Parameters

• dist: string

Returns

string

Inherited from

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<any>

Parameters

• outDir: string

• arch: Arch

• targets: Target[]

• taskManager: AsyncTaskManager

Returns

Promise<any>

Inherited from

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

Inherited from

PlatformPackager.prepareAppInfo

---

resolveIcon()

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

Parameters

• sources: string[]

• fallbackSources: string[]

• outputFormat: IconFormat

Returns

Promise<IconInfo[]>

Inherited from

PlatformPackager.resolveIcon

---

sign()

sign(file): Promise<boolean>

Parameters

• file: string

Returns

Promise<boolean>

---

signAndEditResources()

signAndEditResources(file, arch, outDir, internalName?, requestedExecutionLevel?): Promise<void>

Parameters

• file: string

• arch: Arch

• outDir: string

• internalName?: null | string

• requestedExecutionLevel?: null | RequestedExecutionLevel

Returns

Promise<void>

---

signApp()

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

Parameters

• packContext: PackContext

• isAsar: boolean

Returns

Promise<boolean>

Overrides

PlatformPackager.signApp