Class ErrorMessage

An error message.

Hierarchy (View Summary)

AnsiMessage
- ErrorMessage

Indexable

[n: number]: AnsiString

Index

Constructors

Accessors

Methods

add toString wrap

Constructors

constructor

new ErrorMessage(arrayLength: number): ErrorMessage
Parameters
- arrayLength: number
Returns ErrorMessage
Inherited from AnsiMessage.constructor
- Defined in node_modules/typescript/lib/lib.es5.d.ts:1508
new ErrorMessage(...items: AnsiString[]): ErrorMessage
Parameters
- ...items: AnsiString[]
Returns ErrorMessage
Inherited from AnsiMessage.constructor
- Defined in node_modules/typescript/lib/lib.es5.d.ts:1509

Accessors

message

get message(): string
Returns string
The wrapped message
Inherited from AnsiMessage.message
- Defined in packages/tsargp/src/library/styles.ts:938

Methods

add

add(
    itemOrPhrase: string | ErrorItem,
    flags?: FormattingFlags,
    ...args: Args,
): this
Appends a ANSI string formatted from an error item or custom phrase, with a trailing line feed.
Parameters
- itemOrPhrase: string | ErrorItem
  The error item or phrase
- Optionalflags: FormattingFlags
  The formatting flags
- ...args: Args
  The error arguments
Returns this
The error message instance
Overrides AnsiMessage.add
- Defined in packages/tsargp/src/library/styles.ts:954

toString

toString(): string
Returns string
The wrapped message
Overrides AnsiMessage.toString
- Defined in packages/tsargp/src/library/styles.ts:963

wrap

wrap(width?: number, emitStyles?: boolean, emitSpaces?: boolean): string
Wraps the help message to a specified width.
Parameters
- width: number = 0
  The terminal width (or zero to avoid wrapping)
- emitStyles: boolean = ...
  True if styles should be emitted
- emitSpaces: boolean = ...
  True if spaces should be emitted instead of move sequences
Returns string
The message to be printed on a terminal
Inherited from AnsiMessage.wrap
- Defined in packages/tsargp/src/library/styles.ts:902