electron builder.Class.Packager

Electron-Builder / electron-builder / Packager

构造函数¶

new Packager()¶

new Packager(options, cancellationToken?): Packager

参数¶

• options: PackagerOptions

• cancellationToken?: CancellationToken

返回值¶

Packager

属性¶

_appInfo¶

_appInfo: null | AppInfo

cancellationToken¶

readonly cancellationToken: CancellationToken

debugLogger¶

readonly debugLogger: DebugLogger

isTwoPackageJsonProjectLayoutUsed¶

isTwoPackageJsonProjectLayoutUsed: boolean

options¶

readonly options: PackagerOptions

projectDir¶

readonly projectDir: string

stageDirPathCustomizer()¶

stageDirPathCustomizer: (target, packager, arch) => string

参数¶

• target: Target

• packager: PlatformPackager<any>

• arch: Arch

返回值¶

string

tempDirManager¶

readonly tempDirManager: TmpDir

访问器¶

appDir¶

get appDir(): string

返回值¶

string

appInfo¶

get appInfo(): AppInfo

返回值¶

AppInfo

areNodeModulesHandledExternally¶

get areNodeModulesHandledExternally(): boolean

返回值¶

boolean

buildResourcesDir¶

get buildResourcesDir(): string

返回值¶

string

config¶

get config(): Configuration

返回值¶

Configuration

devMetadata¶

get devMetadata(): null | Metadata

返回值¶

null | Metadata

framework¶

get framework(): Framework

返回值¶

Framework

isPrepackedAppAsar¶

get isPrepackedAppAsar(): boolean

返回值¶

boolean

metadata¶

get metadata(): Metadata

返回值¶

Metadata

relativeBuildResourcesDirname¶

get relativeBuildResourcesDirname(): string

返回值¶

string

repositoryInfo¶

get repositoryInfo(): Promise<null | SourceRepositoryInfo>

返回值¶

Promise<null | SourceRepositoryInfo>

方法¶

addPackagerEventHandlers()¶

addPackagerEventHandlers(): Promise<void>

返回值¶

Promise<void>

build()¶

build(repositoryInfo?): Promise<BuildResult>

参数¶

• repositoryInfo?: SourceRepositoryInfo

返回值¶

Promise<BuildResult>

clearPackagerEventListeners()¶

clearPackagerEventListeners(): void

返回值¶

void

disposeOnBuildFinish()¶

disposeOnBuildFinish(disposer): void

参数¶

• disposer

返回值¶

void

emitAfterExtract()¶

emitAfterExtract(context): Promise<void>

参数¶

• context: PackContext

返回值¶

Promise<void>

emitAfterPack()¶

emitAfterPack(context): Promise<void>

参数¶

• context: PackContext

返回值¶

Promise<void>

emitAfterSign()¶

emitAfterSign(context): Promise<void>

参数¶

• context: PackContext

返回值¶

Promise<void>

emitAppxManifestCreated()¶

emitAppxManifestCreated(path): Promise<void>

参数¶

• path: string

返回值¶

Promise<void>

emitArtifactBuildCompleted()¶

emitArtifactBuildCompleted(event): Promise<void>

参数¶

• event: ArtifactCreated

返回值¶

Promise<void>

emitArtifactBuildStarted()¶

emitArtifactBuildStarted(event, logFields?): Promise<void>

参数¶

• event: ArtifactBuildStarted

• logFields?: any

返回值¶

Promise<void>

emitArtifactCreated()¶

emitArtifactCreated(event): Promise<void>

仅用于子工件（更新信息），对于主要工件，请使用 callArtifactBuildCompleted。

参数¶

• event: ArtifactCreated

返回值¶

Promise<void>

emitBeforePack()¶

emitBeforePack(context): Promise<void>

参数¶

• context: PackContext

返回值¶

Promise<void>

emitMsiProjectCreated()¶

emitMsiProjectCreated(path): Promise<void>

参数¶

• path: string

返回值¶

Promise<void>

filterPackagerEventListeners()¶

filterPackagerEventListeners(event, type): object[]

参数¶

• event: keyof PackagerEvents

• type: undefined | HandlerType

返回值¶

object[]

getNodeDependencyInfo()¶

getNodeDependencyInfo(platform, flatten?): Lazy<(NodeModuleDirInfo | NodeModuleInfo)[]>

参数¶

• platform: null | Platform

• flatten?: boolean

返回值¶

Lazy<(NodeModuleDirInfo | NodeModuleInfo)[]>

installAppDependencies()¶

installAppDependencies(platform, arch): Promise<any>

参数¶

• platform: Platform

• arch: Arch

返回值¶

Promise<any>

onAfterPack()¶

onAfterPack(handler): Packager

参数¶

• handler: Hook<PackContext, void>

返回值¶

Packager

onArtifactCreated()¶

onArtifactCreated(handler): Packager

参数¶

• handler: Hook<ArtifactCreated, void>

返回值¶

Packager

validateConfig()¶

validateConfig(): Promise<void>

返回值¶

Promise<void>