Globals

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

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

plugin

Type aliases

AuditExtendedMetadata

AuditExtendedMetadata: AuditMetadata & object

AuditExtendedResponse

AuditExtendedResponse: Record<string, Array<AuditExtendedMetadata>>

AuditResponse

AuditResponse: Record<string, Array<AuditMetadata>>

CombinedPackument

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

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

TopLevelDependency

TopLevelDependency: object

Type declaration

dependency: Descriptor
workspace: Workspace

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

- Defined in packages/plugin-npm-cli/sources/commands/npm/info.ts:217
Removes hidden properties (the ones that start with an underscore) recursively.

Parameters
- value: unknown
Returns unknown

getCredentials

getCredentials(__namedParameters: object): Promise<object>

- Defined in packages/plugin-npm-cli/sources/commands/npm/login.ts:131
Parameters
- __namedParameters: object
  - configuration: Configuration
  - registry: string
  - report: Report
  - stdin: ReadStream
  - stdout: WriteStream
Returns Promise<object>

getDistTags

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

- Defined in packages/plugin-npm-cli/sources/commands/npm/tag/list.ts:70
Parameters
- ident: Ident
- configuration: Configuration
Returns Promise<Record<string, string>>

getPackages

getPackages(project: Project, roots: Array<TopLevelDependency>, __namedParameters: object): Map<string, Map<string, Locator[]>>

- Defined in packages/plugin-npm-cli/sources/npmAuditUtils.ts:108
Parameters
- project: Project
- roots: Array<TopLevelDependency>
- __namedParameters: object
  - recursive: boolean
Returns Map<string, Map<string, Locator[]>>

getRegistry

getRegistry(__namedParameters: object): Promise<string>

- Defined in packages/plugin-npm-cli/sources/commands/npm/login.ts:90
Parameters
- __namedParameters: object
  - configuration: Configuration
  - cwd: string & object
  - publish: boolean
  - scope: undefined | string
Returns Promise<string>

getReportTree

getReportTree(result: npmAuditTypes.AuditExtendedResponse): object

- Defined in packages/plugin-npm-cli/sources/npmAuditUtils.ts:24
Parameters
- result: npmAuditTypes.AuditExtendedResponse
Returns object
- Optional children?: Array<TreeNode> | TreeMap
- Optional label?: undefined | string
- Optional value?: formatUtils.Tuple

getSeverityInclusions

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

- Defined in packages/plugin-npm-cli/sources/npmAuditUtils.ts:14
Parameters
- Optional severity: npmAuditTypes.Severity
Returns Set<Severity>

getTopLevelDependencies

getTopLevelDependencies(project: Project, workspace: Workspace, __namedParameters: object): object[]

- Defined in packages/plugin-npm-cli/sources/npmAuditUtils.ts:78
Parameters
- project: Project
- workspace: Workspace
- __namedParameters: object
  - all: boolean
  - environment: Environment
Returns object[]

logoutFrom

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

- Defined in packages/plugin-npm-cli/sources/commands/npm/logout.ts:179
Parameters
- entryType: "npmRegistries" | "npmScopes"
- entryName: string
Returns Promise<boolean>

logoutFromEverything

logoutFromEverything(): Promise<boolean>

- Defined in packages/plugin-npm-cli/sources/commands/npm/logout.ts:146
Returns Promise<boolean>

removeTokenFromStore

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

- Defined in packages/plugin-npm-cli/sources/commands/npm/logout.ts:120
Parameters
- nextStore: object
  - [key: string]: unknown
- entryName: string
Returns boolean

setAuthToken

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

- Defined in packages/plugin-npm-cli/sources/commands/npm/login.ts:103
Parameters
- registry: string
- npmAuthToken: string
- __namedParameters: object
  - alwaysAuth: undefined | false | true
  - scope: undefined | string
Returns Promise<boolean>

Object literals

Const plugin

plugin: object

commands

commands: (NpmAuditCommand | NpmInfoCommand | NpmPublishCommand | NpmTagAddCommand | NpmTagListCommand | NpmWhoamiCommand)[] = [NpmAuditCommand,NpmInfoCommand,NpmLoginCommand,NpmLogoutCommand,NpmPublishCommand,NpmTagAddCommand,NpmTagListCommand,NpmTagRemoveCommand,NpmWhoamiCommand,]

configuration

configuration: object

npmAuditExcludePackages

npmAuditExcludePackages: object

default

default: never[] = []

description

description: string = `Array of glob patterns of packages to exclude from npm audit`

isArray

isArray: true = true

type

type: STRING = SettingsType.STRING

npmAuditIgnoreAdvisories

npmAuditIgnoreAdvisories: object

default

default: never[] = []

description

description: string = `Array of glob patterns of advisory IDs to exclude from npm audit`

isArray

isArray: true = true

type

type: STRING = SettingsType.STRING

npmPublishAccess

npmPublishAccess: object

default

default: null = null

description

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

type

type: STRING = SettingsType.STRING

Package plugin-npm-cli

@yarnpkg/plugin-npm-cli

Install

Commands

Namespaces

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

AuditExtendedMetadata

AuditExtendedResponse

AuditResponse

CombinedPackument

TopLevelDependency

Type declaration

dependency: Descriptor

workspace: Workspace

Variables

Const LOGOUT_KEYS

Const allSeverities

Functions

clean

Parameters

value: unknown

Returns unknown

getCredentials

Parameters

__namedParameters: object

configuration: Configuration

registry: string

report: Report

stdin: ReadStream

stdout: WriteStream

Returns Promise<object>

getDistTags

Parameters

ident: Ident

configuration: Configuration

Returns Promise<Record<string, string>>

getPackages

Parameters

project: Project

roots: Array<TopLevelDependency>

__namedParameters: object

recursive: boolean

Returns Map<string, Map<string, Locator[]>>

getRegistry

Parameters

__namedParameters: object

configuration: Configuration

cwd: string & object

publish: boolean

scope: undefined | string

Returns Promise<string>

getReportTree

Parameters

result: npmAuditTypes.AuditExtendedResponse

Returns object

Optional children?: Array<TreeNode> | TreeMap

Optional label?: undefined | string

Optional value?: formatUtils.Tuple

getSeverityInclusions

Parameters

Optional severity: npmAuditTypes.Severity

Returns Set<Severity>

getTopLevelDependencies

Parameters

project: Project

workspace: Workspace

__namedParameters: object

all: boolean

environment: Environment

Returns object[]

logoutFrom

Parameters

entryType: "npmRegistries" | "npmScopes"

`@yarnpkg/plugin-npm-cli`