electron builder.Class.Packager

Electron-Builder / electron-builder / Packager

Constructors¶

new Packager()¶

new Packager(options, cancellationToken?): Packager

Parameters¶

• options: PackagerOptions

• cancellationToken?: CancellationToken

Returns¶

Packager

Properties¶

_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

Parameters¶

• target: Target

• packager: PlatformPackager<any>

• arch: Arch

Returns¶

string

tempDirManager¶

readonly tempDirManager: TmpDir

Accessors¶

appDir¶

get appDir(): string

Returns¶

string

appInfo¶

get appInfo(): AppInfo

Returns¶

AppInfo

areNodeModulesHandledExternally¶

get areNodeModulesHandledExternally(): boolean

Returns¶

boolean

buildResourcesDir¶

get buildResourcesDir(): string

Returns¶

string

config¶

get config(): Configuration

Returns¶

Configuration

devMetadata¶

get devMetadata(): null | Metadata

Returns¶

null | Metadata

framework¶

get framework(): Framework

Returns¶

Framework

isPrepackedAppAsar¶

get isPrepackedAppAsar(): boolean

Returns¶

boolean

metadata¶

get metadata(): Metadata

Returns¶

Metadata

relativeBuildResourcesDirname¶

get relativeBuildResourcesDirname(): string

Returns¶

string

repositoryInfo¶

get repositoryInfo(): Promise<null | SourceRepositoryInfo>

Returns¶

Promise<null | SourceRepositoryInfo>

Methods¶

addPackagerEventHandlers()¶

addPackagerEventHandlers(): void

Returns¶

void

build()¶

build(repositoryInfo?): Promise<BuildResult>

Parameters¶

• repositoryInfo?: SourceRepositoryInfo

Returns¶

Promise<BuildResult>

clearPackagerEventListeners()¶

clearPackagerEventListeners(): void

Returns¶

void

disposeOnBuildFinish()¶

disposeOnBuildFinish(disposer): void

Parameters¶

• disposer

Returns¶

void

emitAfterExtract()¶

emitAfterExtract(context): Promise<void>

Parameters¶

• context: PackContext

Returns¶

Promise<void>

emitAfterPack()¶

emitAfterPack(context): Promise<void>

Parameters¶

• context: PackContext

Returns¶

Promise<void>

emitAfterSign()¶

emitAfterSign(context): Promise<void>

Parameters¶

• context: PackContext

Returns¶

Promise<void>

emitAppxManifestCreated()¶

emitAppxManifestCreated(path): Promise<void>

Parameters¶

• path: string

Returns¶

Promise<void>

emitArtifactBuildCompleted()¶

emitArtifactBuildCompleted(event): Promise<void>

Parameters¶

• event: ArtifactCreated

Returns¶

Promise<void>

emitArtifactBuildStarted()¶

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

Parameters¶

• event: ArtifactBuildStarted

• logFields?: any

Returns¶

Promise<void>

emitArtifactCreated()¶

emitArtifactCreated(event): Promise<void>

Only for sub artifacts (update info), for main artifacts use callArtifactBuildCompleted.

Parameters¶

• event: ArtifactCreated

Returns¶

Promise<void>

emitBeforePack()¶

emitBeforePack(context): Promise<void>

Parameters¶

• context: PackContext

Returns¶

Promise<void>

emitMsiProjectCreated()¶

emitMsiProjectCreated(path): Promise<void>

Parameters¶

• path: string

Returns¶

Promise<void>

filterPackagerEventListeners()¶

filterPackagerEventListeners(event, type): object[]

Parameters¶

• event: keyof PackagerEvents

• type: undefined | HandlerType

Returns¶

object[]

getNodeDependencyInfo()¶

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

Parameters¶

• platform: null | Platform

• flatten?: boolean

Returns¶

Lazy<(NodeModuleDirInfo | NodeModuleInfo)[]>

installAppDependencies()¶

installAppDependencies(platform, arch): Promise<any>

Parameters¶

• platform: Platform

• arch: Arch

Returns¶

Promise<any>

onAfterPack()¶

onAfterPack(handler): Packager

Parameters¶

• handler: Hook<PackContext, void>

Returns¶

Packager

onArtifactCreated()¶

onArtifactCreated(handler): Packager

Parameters¶

• handler: Hook<ArtifactCreated, void>

Returns¶

Packager

validateConfig()¶

validateConfig(): Promise<void>

Returns¶

Promise<void>