Search
Preparing search index...
The search index is not available
Yarn API
Home
Configuration
Features
CLI
Advanced
GitHub
Options
All
Public
Public/Protected
All
Inherited
Externals
Only exported
Menu
plugin-pnpm
PnpmInstaller
Globals
{"Generic Packages":{"@yarnpkg/core":"yarnpkg_core","@yarnpkg/fslib":"yarnpkg_fslib","@yarnpkg/libzip":"yarnpkg_libzip","@yarnpkg/nm":"yarnpkg_nm","@yarnpkg/parsers":"yarnpkg_parsers","@yarnpkg/pnp":"yarnpkg_pnp","@yarnpkg/pnpify":"yarnpkg_pnpify","@yarnpkg/sdks":"yarnpkg_sdks","@yarnpkg/shell":"yarnpkg_shell"},"Yarn Packages":{"@yarnpkg/builder":"yarnpkg_builder","@yarnpkg/cli":"yarnpkg_cli"},"Default Plugins":{"@yarnpkg/plugin-compat":"plugin_compat","@yarnpkg/plugin-dlx":"plugin_dlx","@yarnpkg/plugin-essentials":"plugin_essentials","@yarnpkg/plugin-file":"plugin_file","@yarnpkg/plugin-git":"plugin_git","@yarnpkg/plugin-github":"plugin_github","@yarnpkg/plugin-http":"plugin_http","@yarnpkg/plugin-init":"plugin_init","@yarnpkg/plugin-link":"plugin_link","@yarnpkg/plugin-nm":"plugin_nm","@yarnpkg/plugin-npm":"plugin_npm","@yarnpkg/plugin-npm-cli":"plugin_npm_cli","@yarnpkg/plugin-pack":"plugin_pack","@yarnpkg/plugin-patch":"plugin_patch","@yarnpkg/plugin-pnp":"plugin_pnp"},"Contrib Plugins":{"@yarnpkg/plugin-constraints":"plugin_constraints","@yarnpkg/plugin-exec":"plugin_exec","@yarnpkg/plugin-interactive-tools":"plugin_interactive_tools","@yarnpkg/plugin-stage":"plugin_stage","@yarnpkg/plugin-typescript":"plugin_typescript","@yarnpkg/plugin-version":"plugin_version","@yarnpkg/plugin-workspace-tools":"plugin_workspace_tools"}}
Class PnpmInstaller
Hierarchy
PnpmInstaller
Implements
Installer
Constructors
constructor
Properties
asyncActions
indexFolderPromise
opts
Methods
attachCustomData
attachExternalDependents
attachInternalDependencies
finalizeInstall
installPackage
installPackageHard
installPackageSoft
Object literals
customData
Constructors
constructor
new
Pnpm
Installer
(
opts
:
LinkOptions
)
:
PnpmInstaller
Parameters
opts:
LinkOptions
Returns
PnpmInstaller
Properties
Private
async
Actions
async
Actions
:
AsyncActions
= new miscUtils.AsyncActions(10)
Private
index
Folder
Promise
index
Folder
Promise
:
Promise
<
PortablePath
>
Private
opts
opts
:
LinkOptions
Methods
attach
Custom
Data
attach
Custom
Data
(
customData
:
any
)
:
void
Parameters
customData:
any
Returns
void
attach
External
Dependents
attach
External
Dependents
(
locator
:
Locator
, dependentPaths
:
Array
<
PortablePath
>
)
:
Promise
<
void
>
Parameters
locator:
Locator
dependentPaths:
Array
<
PortablePath
>
Returns
Promise
<
void
>
attach
Internal
Dependencies
attach
Internal
Dependencies
(
locator
:
Locator
, dependencies
:
Array
<
[]
>
)
:
Promise
<
void
>
Parameters
locator:
Locator
dependencies:
Array
<
[]
>
Returns
Promise
<
void
>
finalize
Install
finalize
Install
(
)
:
Promise
<
object
>
Returns
Promise
<
object
>
install
Package
install
Package
(
pkg
:
Package
, fetchResult
:
FetchResult
, api
:
InstallPackageExtraApi
)
:
Promise
<
object
|
object
>
Parameters
pkg:
Package
fetchResult:
FetchResult
api:
InstallPackageExtraApi
Returns
Promise
<
object
|
object
>
install
Package
Hard
install
Package
Hard
(
pkg
:
Package
, fetchResult
:
FetchResult
, api
:
InstallPackageExtraApi
)
:
Promise
<
object
>
Parameters
pkg:
Package
fetchResult:
FetchResult
api:
InstallPackageExtraApi
Returns
Promise
<
object
>
install
Package
Soft
install
Package
Soft
(
pkg
:
Package
, fetchResult
:
FetchResult
, api
:
InstallPackageExtraApi
)
:
Promise
<
object
>
Parameters
pkg:
Package
fetchResult:
FetchResult
api:
InstallPackageExtraApi
Returns
Promise
<
object
>
Object literals
Private
custom
Data
custom
Data
:
object
locator
ByPath
locator
ByPath
:
Map
<
any
,
any
>
= new Map()
paths
ByLocator
paths
ByLocator
:
Map
<
any
,
any
>
= new Map()
plugin-
pnpm
Pnpm
Installer
constructor
async
Actions
index
Folder
Promise
opts
attach
Custom
Data
attach
External
Dependents
attach
Internal
Dependencies
finalize
Install
install
Package
install
Package
Hard
install
Package
Soft
custom
Data
Pnpm
Linker
Pnpm
Custom
Data
clean
Node
Modules
get
Node
Modules
Listing
get
Node
Modules
Location
get
Package
Paths
get
Store
Location
is
Pnpm
Virtual
Compatible
remove
IfEmpty
plugin
Generated using
TypeDoc