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.

Enumerations

Classes

Type aliases

AuthOptions

AuthOptions: object

Type declaration

Optional authType?: AuthType

Options

Options: httpUtils.Options & AuthOptions & RegistryOptions

RegistryOptions

RegistryOptions: object | object

Variables

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 PROTOCOL

PROTOCOL: "npm:" = `npm:`

Functions

askForOtp

askForOtp(): Promise<string>

- Defined in packages/plugin-npm/sources/npmHttpUtils.ts:197
Returns Promise<string>

del

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

- Defined in packages/plugin-npm/sources/npmHttpUtils.ts:107
Parameters
- path: string
- __namedParameters: object
  - attemptedAs: undefined | string
  - authType: AuthType
  - configuration: Configuration
  - headers: undefined | object
  - ident: undefined | Ident
  - 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:38
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>

getAuthConfiguration

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

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

getAuthenticationHeader

getAuthenticationHeader(registry: string, __namedParameters: object): null | string

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

getDefaultRegistry

getDefaultRegistry(__namedParameters: object): string

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

getIdentUrl

getIdentUrl(ident: Ident): string

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

getOtpHeaders

getOtpHeaders(otp: string): object

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

getPublishRegistry

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

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

getRegistryConfiguration

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

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

getScopeConfiguration

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

- Defined in packages/plugin-npm/sources/npmConfigUtils.ts:60
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:26
Parameters
- scope: string | null
- __namedParameters: object
  - configuration: Configuration
  - type: RegistryType
Returns string

isOtpError

isOtpError(error: any): any

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

normalizeRegistry

normalizeRegistry(registry: string): string

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

put

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

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

shouldAuthenticate

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

- Defined in packages/plugin-npm/sources/npmHttpUtils.ts:164
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:181
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

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

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

Const plugin

plugin: object

fetchers

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

resolvers

resolvers: (NpmRemapResolver | 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

npmPublishRegistry

npmPublishRegistry: object

default

default: null = null

description

description: string = `Registry to push packages to`

type

type: STRING = SettingsType.STRING

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

Package plugin-npm

@yarnpkg/plugin-npm

Install

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

AuthOptions

Type declaration

Optional authType?: AuthType

Options

RegistryOptions

Variables

Const NODE_GYP_IDENT

Const NODE_GYP_MATCH

Const PROTOCOL

Functions

askForOtp

Returns Promise<string>

del

Parameters

path: string

__namedParameters: object

attemptedAs: undefined | string

authType: AuthType

configuration: Configuration

headers: undefined | object

ident: undefined | Ident

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>

getAuthConfiguration

Parameters

registry: string

__namedParameters: object

configuration: Configuration

ident: undefined | Ident

Returns MapLike

getAuthenticationHeader

Parameters

registry: string

__namedParameters: object

authType: AuthType

configuration: Configuration

ident: undefined | Ident

Returns null | string

getDefaultRegistry

Parameters

__namedParameters: object

configuration: Configuration

type: RegistryType

Returns string

getIdentUrl

Parameters

ident: Ident

Returns string

getOtpHeaders

Parameters

otp: string

Returns object

npm-otp: string

getPublishRegistry

Parameters

manifest: Manifest

__namedParameters: object

`@yarnpkg/plugin-npm`