Globals

Package yarnpkg-cli

Classes

Type aliases

YarnCli

Variables

Functions

Type aliases

YarnCli

YarnCli: ReturnType<typeof getBaseCli>

Variables

Const fs

fs: "fs" = require(`fs`)

Const pluginCommands

pluginCommands: Map<string, string[]> = new Map<string, Array<string>>([])

Const pnpFile

pnpFile: string = `${__dirname}/../../../.pnp.cjs`

Functions

checkCwd

checkCwd(cli: YarnCli, argv: Array<string>): string[]

- Defined in packages/yarnpkg-cli/sources/lib.ts:92
Parameters
- cli: YarnCli
- argv: Array<string>
Returns string[]

getBaseCli

getBaseCli(__namedParameters: object): Cli<object> & object

- Defined in packages/yarnpkg-cli/sources/lib.ts:12
Parameters
- __namedParameters: object
  - cwd: string & object
  - pluginConfiguration: object
    - modules: Map<string, any>
    - plugins: Set<string>
Returns Cli<object> & object

getCli

getCli(__namedParameters?: object): Promise<Cli<object> & object>

- Defined in packages/yarnpkg-cli/sources/lib.ts:173
Parameters
- Default value __namedParameters: object = {}
  - cwd: string & object
  - pluginConfiguration: object
    - modules: Map<string, any>
    - plugins: Set<string>
Returns Promise<Cli<object> & object>

getCoreConfiguration

getCoreConfiguration(__namedParameters: object): Promise<Configuration>

- Defined in packages/yarnpkg-cli/sources/lib.ts:55
Parameters
- __namedParameters: object
  - pluginConfiguration: object
    - modules: Map<string, any>
    - plugins: Set<string>
  - selfPath: null | string & object
Returns Promise<Configuration>

Const getDynamicLibs

getDynamicLibs(): Map<string, any>

- Defined in packages/yarnpkg-cli/sources/tools/getDynamicLibs.ts:11
Returns Map<string, any>

getPluginConfiguration

getPluginConfiguration(): PluginConfiguration

- Defined in packages/yarnpkg-cli/sources/tools/getPluginConfiguration.ts:6
Returns PluginConfiguration

initCommands

initCommands(cli: YarnCli, __namedParameters: object): void

- Defined in packages/yarnpkg-cli/sources/lib.ts:135
Parameters
- cli: YarnCli
- __namedParameters: object
  - configuration: Configuration
Returns void

initTelemetry

initTelemetry(cli: YarnCli, __namedParameters: object): void

- Defined in packages/yarnpkg-cli/sources/lib.ts:117
Parameters
- cli: YarnCli
- __namedParameters: object
  - configuration: Configuration
Returns void

openWorkspace

openWorkspace(configuration: Configuration, cwd: PortablePath): Promise<Workspace>

- Defined in packages/yarnpkg-cli/sources/tools/openWorkspace.ts:6
Parameters
- configuration: Configuration
- cwd: PortablePath
Returns Promise<Workspace>

run

run(cli: YarnCli, argv: Array<string>, __namedParameters: object): Promise<number>

- Defined in packages/yarnpkg-cli/sources/lib.ts:143
Parameters
- cli: YarnCli
- argv: Array<string>
- __namedParameters: object
  - pluginConfiguration: object
    - modules: Map<string, any>
    - plugins: Set<string>
  - selfPath: null | string & object
Returns Promise<number>

runExit

runExit(argv: Array<string>, __namedParameters: object): Promise<void>

- Defined in packages/yarnpkg-cli/sources/lib.ts:186
Parameters
- argv: Array<string>
- __namedParameters: object
  - cwd: string & object
  - pluginConfiguration: object
    - modules: Map<string, any>
    - plugins: Set<string>
  - selfPath: null | string & object
Returns Promise<void>

runYarnPath

runYarnPath(cli: YarnCli, argv: Array<string>, __namedParameters: object): number

- Defined in packages/yarnpkg-cli/sources/lib.ts:64
Parameters
- cli: YarnCli
- argv: Array<string>
- __namedParameters: object
  - yarnPath: string & object
Returns number

validateNodejsVersion

validateNodejsVersion(cli: YarnCli): boolean

- Defined in packages/yarnpkg-cli/sources/lib.ts:32
Parameters
- cli: YarnCli
Returns boolean

Generated using TypeDoc