Skip to main content

Installer

Implemented by

PnpInstaller

Index

Methods

Methods

attachCustomData

attachCustomData(customData: unknown): void

Only called if the installer has a custom data key matching one currently stored. Will be called with whatever finalizeInstall returned in its customData field.
Parameters
- customData: unknown
Returns void

attachExternalDependents

attachExternalDependents(locator: Locator, dependentPaths: PortablePath[]): Promise<void>

Link a package to the location of the external packages that depend on it (only the location is available, since two linkers should be generic enough to not have to make custom integrations).

Will never be called for packages supported by the same linker (they'll be linked through the attachInternalDependencies hook instead).

This function is guaranteed to be called for all packages before the install is finalized.
Parameters
- locator: Locator
- dependentPaths: PortablePath[]
Returns Promise<void>

attachInternalDependencies

attachInternalDependencies(locator: Locator, dependencies: [Descriptor, Locator][]): Promise<void>

Link a package and its internal (same-linker) dependencies.

This function is guaranteed to be called for all packages before the install is finalized.
Parameters
- locator: Locator
  The package itself
- dependencies: [Descriptor, Locator][]
  The package dependencies
Returns Promise<void>

finalizeInstall

finalizeInstall(): Promise<undefined | void | FinalizeInstallData>

Finalize the install by writing miscellaneous files to the disk.
Returns Promise<undefined | void | FinalizeInstallData>

installPackage

installPackage(pkg: Package, fetchResult: FetchResult, api: InstallPackageExtraApi): Promise<InstallStatus>

Install a package on the disk.

Should return null if the package has no install steps, or an object describing the various scripts that need to be run otherwise.

Note that this function isn't called in any specific order. In particular, this means that the order in which this function is called will not necessarily match the order in which the packages will be built.

This function is guaranteed to be called for all packages before the dependencies start to be attached.
Parameters
- pkg: Package
  The package being installed
- fetchResult: FetchResult
  The fetched information about the package
- api: InstallPackageExtraApi
  An additional API one can use to interact with the core
Returns Promise<InstallStatus>