Options
All
  • Public
  • Public/Protected
  • All
Menu

Class NpmLogoutCommand

Hierarchy

Properties

Methods

Properties

all

all: boolean = Option.Boolean(`-A,--all`, false, {description: `Logout of all registries`,})

cwd

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

publish

publish: boolean = Option.Boolean(`--publish`, false, {description: `Logout of the publish registry`,})

scope

scope: undefined | string = Option.String(`-s,--scope`, {description: `Logout of the registry configured for a given scope`,})

Static paths

paths: string[][] = [[`npm`, `logout`],]

Static usage

usage: Usage = Command.Usage({category: `Npm-related commands`,description: `logout of the npm registry`,details: `This command will log you out by modifying your local configuration (in your home folder, never in the project itself) to delete all credentials linked to a registry.Adding the \`-s,--scope\` flag will cause the deletion to be done against whatever registry is configured for the associated scope (see also \`npmScopes\`).Adding the \`--publish\` flag will cause the deletion to be done against the registry used when publishing the package (see also \`publishConfig.registry\` and \`npmPublishRegistry\`).Adding the \`-A,--all\` flag will cause the deletion to be done against all registries and scopes.`,examples: [[`Logout of the default registry`,`yarn npm logout`,], [`Logout of the @my-scope scope`,`yarn npm logout --scope my-scope`,], [`Logout of the publish registry for the current package`,`yarn npm logout --publish`,], [`Logout of all registries`,`yarn npm logout --all`,]],})

Methods

execute

  • execute(): Promise<0 | 1>

Generated using TypeDoc