Options
All
  • Public
  • Public/Protected
  • All
Menu

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.

Type aliases

Options

Options: httpUtils.Options & AuthOptions & RegistryOptions

Options

Options: httpUtils.Options & AuthOptions & RegistryOptions

Variables

Const PROTOCOL

PROTOCOL: "npm:" = `npm:`

Const TAG_REGEXP

TAG_REGEXP: RegExp = /^(?!v)[a-z0-9-]+$/i

Functions

get

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

get

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

getAuthConfiguration

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

getAuthConfiguration

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

getDefaultRegistry

  • getDefaultRegistry(__namedParameters: object): string

getDefaultRegistry

  • getDefaultRegistry(__namedParameters: object): string

getIdentUrl

  • getIdentUrl(ident: Ident): string

getIdentUrl

  • getIdentUrl(ident: Ident): string

getPublishRegistry

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

getPublishRegistry

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

getRegistryConfiguration

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

getRegistryConfiguration

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

getScopeConfiguration

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

getScopeConfiguration

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

getScopeRegistry

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

getScopeRegistry

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

normalizeRegistry

  • normalizeRegistry(registry: string): string

normalizeRegistry

  • normalizeRegistry(registry: string): string

put

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

put

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

Object literals

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

Generated using TypeDoc