@yarnpkg/pnp

Index

Enumerations

• LinkType

Functions

• generateInlinedScript
• generateLoader
• generatePrettyJson
• generateSplitScript
• getESMLoaderTemplate
• hydratePnpFile
• hydratePnpSource
• makeRuntimeApi

Type Aliases

• DependencyTarget
• LocationLengthData
• PackageInformation
• PackageInformationData
• PackageLocator
• PackageRegistry
• PackageRegistryData
• PackageStore
• PackageStoreData
• PhysicalPackageLocator
• PnpApi
• PnpSettings
• ResolveRequestOptions
• ResolveToUnqualifiedOptions
• ResolveUnqualifiedOptions
• RuntimeState
• SerializedState
• TopLevelPackageLocator

Functions

generateInlinedScript

• generateInlinedScript(settings: PnpSettings): string

• Parameters

  • settings: PnpSettings

  Returns string

generateLoader

• generateLoader(shebang: undefined | null | string, loader: string): string

• Parameters

  • shebang: undefined | null | string

  • loader: string

  Returns string

generatePrettyJson

• generatePrettyJson(data: any): string

• Parameters

  • data: any

  Returns string

generateSplitScript

• generateSplitScript(settings: PnpSettings): { dataFile: string; loaderFile: string }

• Parameters

  • settings: PnpSettings

  Returns { dataFile: string; loaderFile: string }

  • dataFile: string

  • loaderFile: string

getESMLoaderTemplate

• getESMLoaderTemplate(): string

• Returns string

hydratePnpFile

• hydratePnpFile(location: PortablePath, __namedParameters: { fakeFs: FakeFS<PortablePath>; pnpapiResolution: string }): Promise<PnpApi>

• Parameters

  • location: PortablePath

  • __namedParameters: { fakeFs: FakeFS<PortablePath>; pnpapiResolution: string }

  Returns Promise<PnpApi>

hydratePnpSource

• hydratePnpSource(source: string, __namedParameters: { basePath: string; fakeFs: FakeFS<PortablePath>; pnpapiResolution: string }): PnpApi

• Parameters

  • source: string

  • __namedParameters: { basePath: string; fakeFs: FakeFS<PortablePath>; pnpapiResolution: string }

  Returns PnpApi

makeRuntimeApi

• makeRuntimeApi(settings: PnpSettings, basePath: string, fakeFs: FakeFS<PortablePath>): PnpApi

• Parameters

  • settings: PnpSettings

  • basePath: string

  • fakeFs: FakeFS<PortablePath>

  Returns PnpApi

Type Aliases

DependencyTarget

DependencyTarget: string | [string, string] | null

LocationLengthData

LocationLengthData: number[]

PackageInformation

PackageInformation<P>: { discardFromLookup: boolean; linkType: LinkType; packageDependencies: Map<string, DependencyTarget>; packageLocation: P; packagePeers: Set<string> }

Type parameters

• P: Path

Type declaration

• discardFromLookup: boolean

• linkType: LinkType

• packageDependencies: Map<string, DependencyTarget>

• packageLocation: P

• packagePeers: Set<string>

PackageInformationData

PackageInformationData<P>: { discardFromLookup?: boolean; linkType: LinkType; packageDependencies: [string, DependencyTarget][]; packageLocation: P; packagePeers?: string[] }

Type parameters

• P: Path

Type declaration

• optionaldiscardFromLookup?: boolean

• linkType: LinkType

• packageDependencies: [string, DependencyTarget][]

• packageLocation: P

• optionalpackagePeers?: string[]

PackageLocator

PackageLocator: PhysicalPackageLocator | TopLevelPackageLocator

PackageRegistry

PackageRegistry: Map<string | null, PackageStore>

PackageRegistryData

PackageRegistryData: [string | null, PackageStoreData][]

PackageStore

PackageStore: Map<string | null, PackageInformation<PortablePath>>

PackageStoreData

PackageStoreData: [string | null, PackageInformationData<PortablePath>][]

PhysicalPackageLocator

PhysicalPackageLocator: { name: string; reference: string }

Type declaration

• name: string

• reference: string

PnpApi

PnpApi: { VERSIONS: { std: number }; findPackageLocator: (location: NativePath) => PhysicalPackageLocator | null; getAllLocators?: () => PhysicalPackageLocator[]; getDependencyTreeRoots: () => PhysicalPackageLocator[]; getLocator: (name: string, referencish: string | [string, string]) => PhysicalPackageLocator; getPackageInformation: (locator: PackageLocator) => PackageInformation<NativePath> | null; resolveRequest: (request: string, issuer: NativePath | null, opts?: ResolveRequestOptions) => NativePath | null; resolveToUnqualified: (request: string, issuer: NativePath | null, opts?: ResolveToUnqualifiedOptions) => NativePath | null; resolveUnqualified: (unqualified: NativePath, opts?: ResolveUnqualifiedOptions) => NativePath; resolveVirtual?: (p: NativePath) => NativePath | null; topLevel: { name: null; reference: null } }

Type declaration

• VERSIONS: { std: number }

  • [key string]: number

  • std: number

• findPackageLocator: (location: NativePath) => PhysicalPackageLocator | null

  • • (location: NativePath): PhysicalPackageLocator | null

    • Parameters

      • location: NativePath

      Returns PhysicalPackageLocator | null

• optionalgetAllLocators?: () => PhysicalPackageLocator[]

  • • (): PhysicalPackageLocator[]

    • Returns PhysicalPackageLocator[]

• getDependencyTreeRoots: () => PhysicalPackageLocator[]

  • • (): PhysicalPackageLocator[]

    • Returns PhysicalPackageLocator[]

• getLocator: (name: string, referencish: string | [string, string]) => PhysicalPackageLocator

  • • (name: string, referencish: string | [string, string]): PhysicalPackageLocator

    • Parameters

      • name: string

      • referencish: string | [string, string]

      Returns PhysicalPackageLocator

• getPackageInformation: (locator: PackageLocator) => PackageInformation<NativePath> | null

  • • (locator: PackageLocator): PackageInformation<NativePath> | null

    • Parameters

      • locator: PackageLocator

      Returns PackageInformation<NativePath> | null

• resolveRequest: (request: string, issuer: NativePath | null, opts?: ResolveRequestOptions) => NativePath | null

  • • (request: string, issuer: NativePath | null, opts?: ResolveRequestOptions): NativePath | null

    • Parameters

      • request: string

      • issuer: NativePath | null

      • optionalopts: ResolveRequestOptions

      Returns NativePath | null

• resolveToUnqualified: (request: string, issuer: NativePath | null, opts?: ResolveToUnqualifiedOptions) => NativePath | null

  • • (request: string, issuer: NativePath | null, opts?: ResolveToUnqualifiedOptions): NativePath | null

    • Parameters

      • request: string

      • issuer: NativePath | null

      • optionalopts: ResolveToUnqualifiedOptions

      Returns NativePath | null

• resolveUnqualified: (unqualified: NativePath, opts?: ResolveUnqualifiedOptions) => NativePath

  • • (unqualified: NativePath, opts?: ResolveUnqualifiedOptions): NativePath

    • Parameters

      • unqualified: NativePath

      • optionalopts: ResolveUnqualifiedOptions

      Returns NativePath

• optionalresolveVirtual?: (p: NativePath) => NativePath | null

  • • (p: NativePath): NativePath | null

    • Parameters

      • p: NativePath

      Returns NativePath | null

• topLevel: { name: null; reference: null }

  • name: null

  • reference: null

PnpSettings

PnpSettings: { dependencyTreeRoots: PhysicalPackageLocator[]; enableTopLevelFallback?: boolean; fallbackExclusionList?: PhysicalPackageLocator[]; fallbackPool?: Map<string, DependencyTarget>; ignorePattern?: string | null; packageRegistry: PackageRegistry; shebang?: string | null }

Type declaration

• dependencyTreeRoots: PhysicalPackageLocator[]

• optionalenableTopLevelFallback?: boolean

• optionalfallbackExclusionList?: PhysicalPackageLocator[]

• optionalfallbackPool?: Map<string, DependencyTarget>

• optionalignorePattern?: string | null

• packageRegistry: PackageRegistry

• optionalshebang?: string | null

ResolveRequestOptions

ResolveRequestOptions: ResolveToUnqualifiedOptions & ResolveUnqualifiedOptions

ResolveToUnqualifiedOptions

ResolveToUnqualifiedOptions: { considerBuiltins?: boolean }

Type declaration

• optionalconsiderBuiltins?: boolean

ResolveUnqualifiedOptions

ResolveUnqualifiedOptions: { conditions?: Set<string>; extensions?: string[] }

Type declaration

• optionalconditions?: Set<string>

• optionalextensions?: string[]

RuntimeState

RuntimeState: { basePath: PortablePath; dependencyTreeRoots: PhysicalPackageLocator[]; enableTopLevelFallback: boolean; fallbackExclusionList: Map<string, Set<string>>; fallbackPool: Map<string, DependencyTarget>; ignorePattern: RegExp | null; packageLocatorsByLocations: Map<PortablePath, { discardFromLookup: boolean; locator: PhysicalPackageLocator }>; packageRegistry: PackageRegistry }

Type declaration

• basePath: PortablePath

• dependencyTreeRoots: PhysicalPackageLocator[]

• enableTopLevelFallback: boolean

• fallbackExclusionList: Map<string, Set<string>>

• fallbackPool: Map<string, DependencyTarget>

• ignorePattern: RegExp | null

• packageLocatorsByLocations: Map<PortablePath, { discardFromLookup: boolean; locator: PhysicalPackageLocator }>

• packageRegistry: PackageRegistry

SerializedState

SerializedState: { __info: string[]; dependencyTreeRoots: PhysicalPackageLocator[]; enableTopLevelFallback: boolean; fallbackExclusionList: [string, string[]][]; fallbackPool: [string, DependencyTarget][]; ignorePatternData: string | null; packageRegistryData: PackageRegistryData }

Type declaration

• __info: string[]

• dependencyTreeRoots: PhysicalPackageLocator[]

• enableTopLevelFallback: boolean

• fallbackExclusionList: [string, string[]][]

• fallbackPool: [string, DependencyTarget][]

• ignorePatternData: string | null

• packageRegistryData: PackageRegistryData

TopLevelPackageLocator

TopLevelPackageLocator: { name: null; reference: null }

Type declaration

• name: null

• reference: null