Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ExplainCommand

Hierarchy

Properties

Methods

Properties

code

code: undefined | string = Option.String({required: false,validator: t.applyCascade(t.isString(), [t.matchesRegExp(/^YN[0-9]{4}$/),]),})

cwd

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

json

json: boolean = Option.Boolean(`--json`, false, {description: `Format the output as an NDJSON stream`,})

Static paths

paths: string[][] = [[`explain`],]

Static usage

usage: object = Command.Usage({description: `explain an error code`,details: `When the code argument is specified, this command prints its name and its details.When used without arguments, this command lists all error codes and their names.`,examples: [[`Explain an error code`,`$0 explain YN0006`,], [`List all error codes`,`$0 explain`,]],})

Type declaration

Methods

execute

  • execute(): Promise<void>

Generated using TypeDoc