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-pnp
PnpInstaller
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 PnpInstaller
Hierarchy
PnpInstaller
Implements
Installer
Constructors
constructor
Properties
asyncActions
isESMLoaderRequired
mode
opts
packageRegistry
unpluggedPaths
virtualTemplates
Methods
attachCustomData
attachExternalDependents
attachInternalDependencies
finalizeInstall
finalizeInstallWithPnp
getDiskInformation
getPackageInformation
installPackage
isEsmEnabled
locateNodeModules
shouldBeUnplugged
transformPnpSettings
unplugPackage
unplugPackageIfNeeded
Object literals
customData
Constructors
constructor
new
Pnp
Installer
(
opts
:
LinkOptions
)
:
PnpInstaller
Parameters
opts:
LinkOptions
Returns
PnpInstaller
Properties
Private
async
Actions
async
Actions
:
AsyncActions
= new miscUtils.AsyncActions(10)
Private
isESMLoader
Required
isESMLoader
Required
:
boolean
= false
Protected
mode
mode
:
string
= `strict`
Protected
opts
opts
:
LinkOptions
Private
package
Registry
package
Registry
:
PackageRegistry
= new Map()
Private
unplugged
Paths
unplugged
Paths
:
Set
<
string
>
= new Set()
Private
virtual
Templates
virtual
Templates
:
Map
<
LocatorHash
,
object
>
= new Map()
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
<
undefined
|
object
>
Returns
Promise
<
undefined
|
object
>
finalize
Install
With
Pnp
finalize
Install
With
Pnp
(
pnpSettings
:
PnpSettings
)
:
Promise
<
void
>
Parameters
pnpSettings:
PnpSettings
Returns
Promise
<
void
>
Private
get
Disk
Information
get
Disk
Information
(
path
:
PortablePath
)
:
object
Parameters
path:
PortablePath
Returns
object
discard
From
Lookup
:
false
link
Type
:
SOFT
package
Dependencies
:
Map
<
any
,
any
>
package
Location
:
string
&
object
package
Peers
:
Set
<
string
>
Private
get
Package
Information
get
Package
Information
(
locator
:
Locator
)
:
object
Parameters
locator:
Locator
Returns
object
discard
From
Lookup
:
boolean
link
Type
:
LinkType
package
Dependencies
:
Map
<
string
,
DependencyTarget
>
package
Location
:
P
package
Peers
:
Set
<
string
>
install
Package
install
Package
(
pkg
:
Package
, fetchResult
:
FetchResult
, api
:
InstallPackageExtraApi
)
:
Promise
<
object
>
Parameters
pkg:
Package
fetchResult:
FetchResult
api:
InstallPackageExtraApi
Returns
Promise
<
object
>
Private
is
Esm
Enabled
is
Esm
Enabled
(
)
:
boolean
Returns
boolean
Private
locate
Node
Modules
locate
Node
Modules
(
ignorePattern
?:
string
|
null
)
:
Promise
<
(
string
&
object
)
[]
>
Parameters
Optional
ignorePattern:
string
|
null
Returns
Promise
<
(
string
&
object
)
[]
>
Private
should
BeUnplugged
should
BeUnplugged
(
pkg
:
Package
, customPackageData
:
CustomPackageData
, dependencyMeta
:
DependencyMeta
)
:
boolean
Parameters
pkg:
Package
customPackageData:
CustomPackageData
dependencyMeta:
DependencyMeta
Returns
boolean
transform
Pnp
Settings
transform
Pnp
Settings
(
pnpSettings
:
PnpSettings
)
:
Promise
<
void
>
Parameters
pnpSettings:
PnpSettings
Returns
Promise
<
void
>
Private
unplug
Package
unplug
Package
(
locator
:
Locator
, fetchResult
:
FetchResult
, api
:
InstallPackageExtraApi
)
:
Promise
<
CwdFS
|
AliasFS
<
string
&
object
>
>
Parameters
locator:
Locator
fetchResult:
FetchResult
api:
InstallPackageExtraApi
Returns
Promise
<
CwdFS
|
AliasFS
<
string
&
object
>
>
Private
unplug
Package
IfNeeded
unplug
Package
IfNeeded
(
pkg
:
Package
, customPackageData
:
CustomPackageData
, fetchResult
:
FetchResult
, dependencyMeta
:
DependencyMeta
, api
:
InstallPackageExtraApi
)
:
Promise
<
FakeFS
<
string
&
object
>
|
CwdFS
|
AliasFS
<
string
&
object
>
>
Parameters
pkg:
Package
customPackageData:
CustomPackageData
fetchResult:
FetchResult
dependencyMeta:
DependencyMeta
api:
InstallPackageExtraApi
Returns
Promise
<
FakeFS
<
string
&
object
>
|
CwdFS
|
AliasFS
<
string
&
object
>
>
Object literals
Private
custom
Data
custom
Data
:
object
store
store
:
Map
<
any
,
any
>
= new Map()
plugin-
pnp
"@yarnpkg/core"
Pnp
Installer
constructor
async
Actions
isESMLoader
Required
mode
opts
package
Registry
unplugged
Paths
virtual
Templates
attach
Custom
Data
attach
External
Dependents
attach
Internal
Dependencies
finalize
Install
finalize
Install
With
Pnp
get
Disk
Information
get
Package
Information
install
Package
is
Esm
Enabled
locate
Node
Modules
should
BeUnplugged
transform
Pnp
Settings
unplug
Package
unplug
Package
IfNeeded
custom
Data
Pnp
Linker
Unplug
Command
Custom
Package
Data
Extract
Build
Script
Data
Requirements
Unbox
Promise
FORCED_
EXTRACT_
FILETYPES
FORCED_
UNPLUG_
PACKAGES
check
And
Report
Manifest
Compatibility
check
Manifest
Compatibility
extract
Build
Scripts
extract
Custom
Package
Data
get
Extract
Hint
get
Pnp
Path
get
Unplugged
Path
has
Binding
Gyp
normalize
Directory
Path
populate
Yarn
Paths
quote
Path
IfNeeded
setup
Script
Environment
plugin
Generated using
TypeDoc