Options
All
  • Public
  • Public/Protected
  • All
Menu

Package plugin-npm-cli

@yarnpkg/plugin-npm-cli

This plugin adds support for various npm-specific commands.

Install

This plugin is included by default in Yarn.

Commands

Namespaces

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

CombinedPackument

CombinedPackument: Omit<Packument, "versions"> & PackumentVersion

The combined type of Packument (without the versions field) and PackumentVersion

Variables

Const LOGOUT_KEYS

LOGOUT_KEYS: Set<string> = new Set([`npmAuthIdent`,`npmAuthToken`,])

Functions

clean

  • clean(value: unknown): unknown

getCredentials

  • getCredentials(__namedParameters: object): Promise<object>

getDistTags

  • getDistTags(ident: Ident, configuration: Configuration): Promise<Record<string, string>>

getRegistry

  • getRegistry(__namedParameters: object): Promise<string>

logoutFrom

  • logoutFrom(entryType: "npmRegistries" | "npmScopes", entryName: string): Promise<void>

logoutFromEverything

  • logoutFromEverything(): Promise<void>

makePublishBody

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

removeTokenFromStore

  • removeTokenFromStore(nextStore: object, entryName: string): boolean

setAuthToken

  • setAuthToken(registry: string, npmAuthToken: string, __namedParameters: object): Promise<void>

Object literals

Const plugin

plugin: object

commands

commands: (InfoCommand | NpmLoginCommand | NpmPublishCommand | NpmTagAddCommand | NpmTagListCommand | NpmTagRemoveCommand)[] = [npmInfo,npmLogin,npmLogout,npmPublish,npmTagAdd,npmTagList,npmTagRemove,npmWhoami,]

configuration

configuration: object

npmPublishAccess

npmPublishAccess: object

default

default: null = null

description

description: string = `Default access of the published packages`

type

type: STRING = SettingsType.STRING

Generated using TypeDoc