On this page

createColors(colorsOptions?): Colors
Attributes
colorsOptions:ColorsOptions
Returns:Colors
colors

Creates a colors from the provided colors option.

getArguments(schema?): Flags
Attributes
schema:JSONSchema4 & { absolutePath: boolean; cli: { description?: string; exclude?: boolean; helper?: boolean; negatedDescription?: string; resetDescription?: string }; instanceof: string } | JSONSchema6 & { absolutePath: boolean; cli: { description?: string; exclude?: boolean; helper?: boolean; negatedDescription?: string; resetDescription?: string }; instanceof: string } | JSONSchema7 & { absolutePath: boolean; cli: { description?: string; exclude?: boolean; helper?: boolean; negatedDescription?: string; resetDescription?: string }; instanceof: string }
a json schema to create arguments for (by default webpack schema is used)
Returns:Flags
object of arguments

Returns object of arguments.

isColorSupported(): boolean
Returns:boolean
true when colors supported, otherwise false

Checks whether this object is color supported.

processArguments(args, config, values): null | Problem[]
Attributes
args:Flags
object of arguments
config:ObjectConfiguration
configuration
values:Values
object with values
Returns:null | Problem[]
problems or null for success

Processes the provided arg.

Returns object of arguments.

Attributes
configs:ArgumentConfig[]
description:string
multiple:boolean
simpleType:SimpleType

Returns object of arguments.

Attributes
description:string
multiple:boolean
negatedDescription:string
path:string
type:"string" | "number" | "boolean" | "path" | "enum" | "RegExp" | "reset"
values:EnumValue[]
Attributes
bgBlack:(value?: any) => string
bgBlackBright:(value?: any) => string
bgBlue:(value?: any) => string
bgBlueBright:(value?: any) => string
bgCyan:(value?: any) => string
bgCyanBright:(value?: any) => string
bgGreen:(value?: any) => string
bgGreenBright:(value?: any) => string
bgMagenta:(value?: any) => string
bgMagentaBright:(value?: any) => string
bgRed:(value?: any) => string
bgRedBright:(value?: any) => string
bgWhite:(value?: any) => string
bgWhiteBright:(value?: any) => string
bgYellow:(value?: any) => string
bgYellowBright:(value?: any) => string
black:(value?: any) => string
blackBright:(value?: any) => string
blue:(value?: any) => string
blueBright:(value?: any) => string
bold:(value?: any) => string
cyan:(value?: any) => string
cyanBright:(value?: any) => string
dim:(value?: any) => string
gray:(value?: any) => string
green:(value?: any) => string
greenBright:(value?: any) => string
hidden:(value?: any) => string
inverse:(value?: any) => string
italic:(value?: any) => string
magenta:(value?: any) => string
magentaBright:(value?: any) => string
red:(value?: any) => string
redBright:(value?: any) => string
reset:(value?: any) => string
strikethrough:(value?: any) => string
underline:(value?: any) => string
white:(value?: any) => string
whiteBright:(value?: any) => string
yellow:(value?: any) => string
yellowBright:(value?: any) => string

Creates a colors from the provided colors option.

Attributes
useColor:boolean
force use colors
Type:null | string | number | boolean | EnumValueObject | EnumValue[]
  • [index: {string}] any

Returns object of arguments.

Attributes
argument:string
expected:string
index:number
path:string
type:ProblemType
value:string | number | boolean | RegExp
Type:"unknown-argument" | "unexpected-non-array-in-path" | "unexpected-non-object-in-path" | "multiple-values-unexpected" | "invalid-value"
Type:"string" | "number" | "boolean"
Type:string | number | boolean | RegExp
  • [index: {string}] Value[]