Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ConfigSetCommand

Hierarchy

Properties

Methods

Properties

cwd

cwd: undefined | string = Option.String(`--cwd`, {hidden: true})

home

home: boolean = Option.Boolean(`-H,--home`, false, {description: `Update the home configuration instead of the project configuration`,})

json

json: boolean = Option.Boolean(`--json`, false, {description: `Set complex configuration settings to JSON values`,})

name

name: string = Option.String()

value

value: string = Option.String()

Static paths

paths: string[][] = [[`config`, `set`],]

Static usage

usage: Usage = Command.Usage({description: `change a configuration settings`,details: `This command will set a configuration setting.When used without the \`--json\` flag, it can only set a simple configuration setting (a string, a number, or a boolean).When used with the \`--json\` flag, it can set both simple and complex configuration settings, including Arrays and Objects.`,examples: [[`Set a simple configuration setting (a string, a number, or a boolean)`,`yarn config set initScope myScope`,], [`Set a simple configuration setting (a string, a number, or a boolean) using the \`--json\` flag`,`yarn config set initScope --json \\"myScope\\"`,], [`Set a complex configuration setting (an Array) using the \`--json\` flag`,`yarn config set unsafeHttpWhitelist --json '["*.example.com", "example.com"]'`,], [`Set a complex configuration setting (an Object) using the \`--json\` flag`,`yarn config set packageExtensions --json '{ "@babel/parser@*": { "dependencies": { "@babel/types": "*" } } }'`,], [`Set a nested configuration setting`,`yarn config set npmScopes.company.npmRegistryServer "https://npm.example.com"`,], [`Set a nested configuration setting using indexed access for non-simple keys`,`yarn config set 'npmRegistries["//npm.example.com"].npmAuthToken' "ffffffff-ffff-ffff-ffff-ffffffffffff"`,]],})

Methods

execute

  • execute(): Promise<0 | 1>

Generated using TypeDoc