Skip to main content

Class: Packager

Constructors​

Constructor​

new Packager(options, cancellationToken?): Packager

Parameters​

options​

PackagerOptions

cancellationToken?​

CancellationToken

Returns​

Packager

Properties​

_appInfo​

_appInfo: AppInfo | null

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 Signature​

get appDir(): string

Returns​

string

appInfo​

Get Signature​

get appInfo(): AppInfo

Returns​

AppInfo

areNodeModulesHandledExternally​

Get Signature​

get areNodeModulesHandledExternally(): boolean

Returns​

boolean

buildResourcesDir​

Get Signature​

get buildResourcesDir(): string

Returns​

string

config​

Get Signature​

get config(): Configuration

Returns​

Configuration

devMetadata​

Get Signature​

get devMetadata(): Metadata | null

Returns​

Metadata | null

framework​

Get Signature​

get framework(): Framework

Returns​

Framework

isPrepackedAppAsar​

Get Signature​

get isPrepackedAppAsar(): boolean

Returns​

boolean

metadata​

Get Signature​

get metadata(): Metadata

Returns​

Metadata

nodePackageName​

Get Signature​

get nodePackageName(): string

The "name" field from package.json.

Returns​

string

originalMetadata​

Get Signature​

get originalMetadata(): Metadata

Returns​

Metadata

relativeBuildResourcesDirname​

Get Signature​

get relativeBuildResourcesDirname(): string

Returns​

string

repositoryInfo​

Get Signature​

get repositoryInfo(): Promise<SourceRepositoryInfo | null>

Returns​

Promise<SourceRepositoryInfo | null>

Methods​

addBuildFinalizeTask()​

addBuildFinalizeTask(task): void

Parameters​

task​

() => Promise<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​

() => Promise<void>

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​

HandlerType | undefined

Returns​

object[]

getPackageManager()​

getPackageManager(): Promise<PM>

Returns​

Promise<PM>

getWorkspaceRoot()​

getWorkspaceRoot(): Promise<string>

Returns​

Promise<string>

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>