Globals

Package plugin-npm

`@yarnpkg/plugin-npm`

This plugin adds support for downloading packages from the npm registry.

Install

This plugin is included by default in Yarn.

Namespaces

@yarnpkg/core

Enumerations

Classes

Interfaces

Type aliases

Variables

Object literals

Type aliases

CachedMetadata

CachedMetadata: object

Type declaration

Optional etag?: undefined | string
Optional lastModified?: undefined | string
metadata: PackageMetadata

GetPackageMetadataOptions

GetPackageMetadataOptions: Omit<Options, "ident" | "configuration"> & object

Options

Options: httpUtils.Options & RegistryOptions & object

PackageMetadata

PackageMetadata: object

Type declaration

dist-tags: Record<string, string>
versions: Record<string, object & object>

PublishAdditionalParams

PublishAdditionalParams: object

Type declaration

access: string | undefined
Optional gitHead?: undefined | string
registry: string
tag: string

RegistryOptions

RegistryOptions: object | object

Variables

Const CACHED_FIELDS

CACHED_FIELDS: ["name", "dist.tarball", "bin", "scripts", "os", "cpu", "libc", "dependencies", "dependenciesMeta", "optionalDependencies", "peerDependencies", "peerDependenciesMeta", "deprecated"] = [`name`,`dist.tarball`,`bin`,`scripts`,`os`,`cpu`,`libc`,`dependencies`,`dependenciesMeta`,`optionalDependencies`,`peerDependencies`,`peerDependenciesMeta`,`deprecated`,] as const

Const CACHE_KEY

CACHE_KEY: string = hashUtils.makeHash(...CACHED_FIELDS).slice(0, 6)

Used to invalidate the on-disk cache when the format changes.

Const NODE_GYP_IDENT

NODE_GYP_IDENT: Ident = structUtils.makeIdent(null, `node-gyp`)

Const NODE_GYP_MATCH

NODE_GYP_MATCH: RegExp = /\b(node-gyp|prebuild-install)\b/

Const PACKAGE_METADATA_CACHE

PACKAGE_METADATA_CACHE: Map<string & object, object | Promise<object>> = new Map<IdentHash, Promise<PackageMetadata> | PackageMetadata>()

Const PROTOCOL

PROTOCOL: "npm:" = `npm:`

Functions

askForOtp

askForOtp(error: any, __namedParameters: object): Promise<string>

- Defined in packages/plugin-npm/sources/npmHttpUtils.ts:460
Parameters
- error: any
- __namedParameters: object
  - configuration: Configuration
Returns Promise<string>

customPackageError

customPackageError(error: RequestError, configuration: Configuration): null | string

- Defined in packages/plugin-npm/sources/npmHttpUtils.ts:48
Parameters
- error: RequestError
- configuration: Configuration
Returns null | string

del

del(path: string, __namedParameters: object): Promise<Buffer>

- Defined in packages/plugin-npm/sources/npmHttpUtils.ts:353
Parameters
- path: string
- __namedParameters: object
  - attemptedAs: undefined | string
  - authType: AuthType
  - configuration: Configuration
  - headers: undefined | object
  - ident: undefined | Ident
  - otp: undefined | string
  - registry: undefined | string
  - rest: rest | rest
Returns Promise<Buffer>

get

get(path: string, __namedParameters: object): Promise<any>

- Defined in packages/plugin-npm/sources/npmHttpUtils.ts:270
Parameters
- path: string
- __namedParameters: object
  - authType: undefined | NO_AUTH | BEST_EFFORT | CONFIGURATION | ALWAYS_AUTH
  - configuration: Configuration
  - headers: undefined | object
  - ident: undefined | Ident
  - registry: undefined | string
  - rest: rest | rest
Returns Promise<any>

getAuditRegistry

getAuditRegistry(__namedParameters: object): string

- Defined in packages/plugin-npm/sources/npmConfigUtils.ts:18
Parameters
- __namedParameters: object
  - configuration: Configuration
Returns string

getAuthConfiguration

getAuthConfiguration(registry: string, __namedParameters: object): MapLike

- Defined in packages/plugin-npm/sources/npmConfigUtils.ts:80
Parameters
- registry: string
- __namedParameters: object
  - configuration: Configuration
  - ident: undefined | Ident
Returns MapLike

getAuthenticationHeader

getAuthenticationHeader(registry: string, __namedParameters: object): Promise<null | string>

- Defined in packages/plugin-npm/sources/npmHttpUtils.ts:395
Parameters
- registry: string
- __namedParameters: object
  - authType: AuthType
  - configuration: Configuration
  - ident: undefined | Ident
Returns Promise<null | string>

getDefaultRegistry

getDefaultRegistry(__namedParameters: object): string

- Defined in packages/plugin-npm/sources/npmConfigUtils.ts:44
Parameters
- __namedParameters: object
  - configuration: Configuration
  - type: RegistryType
Returns string

getGitHead

getGitHead(workingDir: PortablePath): Promise<undefined | string>

- Defined in packages/plugin-npm/sources/npmPublishUtils.ts:78
Parameters
- workingDir: PortablePath
Returns Promise<undefined | string>

getIdentUrl

getIdentUrl(ident: Ident): string

- Defined in packages/plugin-npm/sources/npmHttpUtils.ts:62
Parameters
- ident: Ident
Returns string

getMetadataFolder

getMetadataFolder(configuration: Configuration): string & object

- Defined in packages/plugin-npm/sources/npmHttpUtils.ts:266
Parameters
- configuration: Configuration
Returns string & object

getOtpHeaders

getOtpHeaders(otp: string): object

- Defined in packages/plugin-npm/sources/npmHttpUtils.ts:524
Parameters
- otp: string
Returns object
- npm-otp: string

getPackageMetadata

getPackageMetadata(ident: Ident, __namedParameters: object): Promise<PackageMetadata>

- Defined in packages/plugin-npm/sources/npmHttpUtils.ts:93
Caches and returns the package metadata for the given ident.

Note: This function only caches and returns specific fields from the metadata. If you need other fields, use the uncached get or consider whether it would make more sense to extract the fields from the on-disk packages using the linkers or from the fetch results using the fetchers.

Note: This function only caches and returns specific fields from the metadata. If you need other fields, use the uncached get or consider whether it would make more sense to extract the fields from the on-disk packages using the linkers or from the fetch results using the fetchers.

Parameters
- ident: Ident
- __namedParameters: object
  - cache: undefined | Cache
  - headers: undefined | object
  - project: Project
  - registry: undefined | string
  - rest: rest
  - version: undefined | string
Returns Promise<PackageMetadata>

getPublishAccess

getPublishAccess(workspace: Workspace, ident: Ident): string

- Defined in packages/plugin-npm/sources/npmPublishUtils.ts:89
Parameters
- workspace: Workspace
- ident: Ident
Returns string

getPublishRegistry

getPublishRegistry(manifest: Manifest, __namedParameters: object): string

- Defined in packages/plugin-npm/sources/npmConfigUtils.ts:22
Parameters
- manifest: Manifest
- __namedParameters: object
  - configuration: Configuration
Returns string

getReadmeContent

getReadmeContent(workspace: Workspace): Promise<string>

- Defined in packages/plugin-npm/sources/npmPublishUtils.ts:105
Parameters
- workspace: Workspace
Returns Promise<string>

getRegistryConfiguration

getRegistryConfiguration(registry: string, __namedParameters: object): MapLike | null

- Defined in packages/plugin-npm/sources/npmConfigUtils.ts:52
Parameters
- registry: string
- __namedParameters: object
  - configuration: Configuration
Returns MapLike | null

getRegistryFolder

getRegistryFolder(configuration: Configuration, registry: string): string & object

- Defined in packages/plugin-npm/sources/npmHttpUtils.ts:259
Parameters
- configuration: Configuration
- registry: string
Returns string & object

getScopeConfiguration

getScopeConfiguration(scope: string | null, __namedParameters: object): MapLike | null

- Defined in packages/plugin-npm/sources/npmConfigUtils.ts:67
Parameters
- scope: string | null
- __namedParameters: object
  - configuration: Configuration
Returns MapLike | null

getScopeRegistry

getScopeRegistry(scope: string | null, __namedParameters: object): string

- Defined in packages/plugin-npm/sources/npmConfigUtils.ts:32
Parameters
- scope: string | null
- __namedParameters: object
  - configuration: Configuration
  - type: RegistryType
Returns string

handleInvalidAuthenticationError

handleInvalidAuthenticationError(error: any, __namedParameters: object): Promise<void>

- Defined in packages/plugin-npm/sources/npmHttpUtils.ts:39
Consumes all 401 Unauthorized errors and reports them as AUTHENTICATION_INVALID.

It doesn't handle 403 Forbidden, as the npm registry uses it when the user attempts a prohibited action, such as publishing a package with a similar name to an existing package.

It doesn't handle 403 Forbidden, as the npm registry uses it when the user attempts a prohibited action, such as publishing a package with a similar name to an existing package.

Parameters
- error: any
- __namedParameters: object
  - attemptedAs: undefined | string
  - configuration: Configuration
  - headers: undefined | object
  - registry: string
Returns Promise<void>

isOtpError

isOtpError(error: any): any

- Defined in packages/plugin-npm/sources/npmHttpUtils.ts:512
Parameters
- error: any
Returns any

Const makeConfiguration

makeConfiguration(): Promise<Configuration>

- Defined in packages/plugin-npm/tests/_makeConfiguration.js:3
Returns Promise<Configuration>

makePublishBody

makePublishBody(workspace: Workspace, buffer: Buffer, __namedParameters: object): Promise<object>

- Defined in packages/plugin-npm/sources/npmPublishUtils.ts:18
Parameters
- workspace: Workspace
- buffer: Buffer
- __namedParameters: object
  - access: undefined | string
  - gitHead: undefined | string
  - registry: string
  - tag: string
Returns Promise<object>

normalizeRegistry

normalizeRegistry(registry: string): string

- Defined in packages/plugin-npm/sources/npmConfigUtils.ts:14
Parameters
- registry: string
Returns string

normalizeRegistry

normalizeRegistry(configuration: Configuration, __namedParameters: object): string

- Defined in packages/plugin-npm/sources/npmHttpUtils.ts:385
Parameters
- configuration: Configuration
- __namedParameters: object
  - ident: undefined | Ident
  - registry: undefined | string
Returns string

pickPackageMetadata

pickPackageMetadata(metadata: PackageMetadata): PackageMetadata

- Defined in packages/plugin-npm/sources/npmHttpUtils.ts:244
Parameters
- metadata: PackageMetadata
Returns PackageMetadata

post

post(path: string, body: httpUtils.Body, __namedParameters: object): Promise<Buffer>

- Defined in packages/plugin-npm/sources/npmHttpUtils.ts:289
Parameters
- path: string
- body: httpUtils.Body
- __namedParameters: object
  - attemptedAs: undefined | string
  - authType: AuthType
  - configuration: Configuration
  - headers: undefined | object
  - ident: undefined | Ident
  - otp: undefined | string
  - registry: undefined | string
  - rest: rest | rest
Returns Promise<Buffer>

put

put(path: string, body: httpUtils.Body, __namedParameters: object): Promise<Buffer>

- Defined in packages/plugin-npm/sources/npmHttpUtils.ts:321
Parameters
- path: string
- body: httpUtils.Body
- __namedParameters: object
  - attemptedAs: undefined | string
  - authType: AuthType
  - configuration: Configuration
  - headers: undefined | object
  - ident: undefined | Ident
  - otp: undefined | string
  - registry: undefined | string
  - rest: rest | rest
Returns Promise<Buffer>

shouldAuthenticate

shouldAuthenticate(authConfiguration: MapLike, authType: AuthType): any

- Defined in packages/plugin-npm/sources/npmHttpUtils.ts:426
Parameters
- authConfiguration: MapLike
- authType: AuthType
Returns any

whoami

whoami(registry: string, headers: object | undefined, __namedParameters: object): Promise<any>

- Defined in packages/plugin-npm/sources/npmHttpUtils.ts:443
Parameters
- registry: string
- headers: object | undefined
- __namedParameters: object
  - configuration: Configuration
Returns Promise<any>

Object literals

Const authSettings

authSettings: object

npmAlwaysAuth

npmAlwaysAuth: object

default

default: boolean = false

description

description: string = `URL of the selected npm registry (note: npm enterprise isn't supported)`

type

type: BOOLEAN = SettingsType.BOOLEAN as const

npmAuthIdent

npmAuthIdent: object

default

default: null = null

description

description: string = `Authentication identity for the npm registry (_auth in npm and yarn v1)`

type

type: SECRET = SettingsType.SECRET as const

npmAuthToken

npmAuthToken: object

default

default: null = null

description

description: string = `Authentication token for the npm registry (_authToken in npm and yarn v1)`

type

type: SECRET = SettingsType.SECRET as const

Const plugin

plugin: object

fetchers

fetchers: (NpmSemverFetcher | NpmHttpFetcher)[] = [NpmHttpFetcher,NpmSemverFetcher,]

resolvers

resolvers: (NpmSemverResolver | NpmTagResolver)[] = [NpmRemapResolver,NpmSemverResolver,NpmTagResolver,]

configuration

configuration: object

npmRegistries

npmRegistries: object

description

description: string = `Settings per registry`

normalizeKeys

normalizeKeys: normalizeRegistry = npmConfigUtils.normalizeRegistry

type

type: MAP = SettingsType.MAP

valueDefinition

valueDefinition: object

description

description: string = ``

type

type: SHAPE = SettingsType.SHAPE

properties

properties: object

npmScopes

npmScopes: object

description

description: string = `Settings per package scope`

type

type: MAP = SettingsType.MAP

valueDefinition

valueDefinition: object

description

description: string = ``

type

type: SHAPE = SettingsType.SHAPE

properties

properties: object

Const registrySettings

registrySettings: object

npmAuditRegistry

npmAuditRegistry: object

default

default: null = null

description

description: string = `Registry to query for audit reports`

type

type: STRING = SettingsType.STRING as const

npmPublishRegistry

npmPublishRegistry: object

default

default: null = null

description

description: string = `Registry to push packages to`

type

type: STRING = SettingsType.STRING as const

npmRegistryServer

npmRegistryServer: object

default

default: string = `https://registry.yarnpkg.com`

description

description: string = `URL of the selected npm registry (note: npm enterprise isn't supported)`

type

type: STRING = SettingsType.STRING as const

Package plugin-npm

@yarnpkg/plugin-npm

Install

Namespaces

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

CachedMetadata

Type declaration

Optional etag?: undefined | string

Optional lastModified?: undefined | string

metadata: PackageMetadata

GetPackageMetadataOptions

Options

PackageMetadata

Type declaration

dist-tags: Record<string, string>

versions: Record<string, object & object>

PublishAdditionalParams

Type declaration

access: string | undefined

Optional gitHead?: undefined | string

registry: string

tag: string

RegistryOptions

Variables

Const CACHED_FIELDS

Const CACHE_KEY

Const NODE_GYP_IDENT

Const NODE_GYP_MATCH

Const PACKAGE_METADATA_CACHE

Const PROTOCOL

Functions

askForOtp

Parameters

error: any

__namedParameters: object

configuration: Configuration

Returns Promise<string>

customPackageError

Parameters

error: RequestError

configuration: Configuration

Returns null | string

del

Parameters

path: string

__namedParameters: object

attemptedAs: undefined | string

authType: AuthType

configuration: Configuration

headers: undefined | object

ident: undefined | Ident

otp: undefined | string

registry: undefined | string

rest: rest | rest

Returns Promise<Buffer>

get

Parameters

path: string

__namedParameters: object

authType: undefined | NO_AUTH | BEST_EFFORT | CONFIGURATION | ALWAYS_AUTH

configuration: Configuration

headers: undefined | object

ident: undefined | Ident

registry: undefined | string

rest: rest | rest

Returns Promise<any>

getAuditRegistry

Parameters

__namedParameters: object

configuration: Configuration

Returns string

getAuthConfiguration

Parameters

`@yarnpkg/plugin-npm`