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

Type aliases

AuditVulnerabilities

AuditVulnerabilities: object

Type declaration

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`,])

Const allSeverities

allSeverities: Severity[] = [npmAuditTypes.Severity.Info,npmAuditTypes.Severity.Low,npmAuditTypes.Severity.Moderate,npmAuditTypes.Severity.High,npmAuditTypes.Severity.Critical,]

Functions

clean

  • clean(value: unknown): unknown

filterVulnerabilities

  • filterVulnerabilities(vulnerabilities: npmAuditTypes.AuditVulnerabilities, severity?: npmAuditTypes.Severity): object

getCredentials

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

getDependencies

  • getDependencies(project: Project, workspace: Workspace, __namedParameters: object): object

getDistTags

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

getRegistry

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

getReportTree

  • getReportTree(result: AuditResponse, severity?: npmAuditTypes.Severity): object

getRequires

  • getRequires(project: Project, workspace: Workspace, __namedParameters: object): object

getSeverityInclusions

  • getSeverityInclusions(severity?: npmAuditTypes.Severity): Set<Severity>

getTransitiveDependencies

getTransitiveDevDependencies

isError

  • isError(vulnerabilities: npmAuditTypes.AuditVulnerabilities, severity?: npmAuditTypes.Severity): boolean

logoutFrom

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

logoutFromEverything

  • logoutFromEverything(): Promise<void>

removeTokenFromStore

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

setAuthToken

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

setDifference

  • setDifference<T>(x: Set<T>, y: Set<T>): Set<T>

transformDescriptorIterableToRequiresObject

  • transformDescriptorIterableToRequiresObject(descriptors: Iterable<Descriptor>): object

Object literals

Const plugin

plugin: object

commands

commands: (AuditCommand | InfoCommand | NpmLoginCommand | NpmPublishCommand | NpmTagAddCommand | NpmTagListCommand)[] = [npmAudit,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