Class AnsiMessage

The ANSI message. Used as base for other message classes.

Hierarchy (View Summary)

Array<AnsiString>
- AnsiMessage
  - ErrorMessage

Indexable

[n: number]: AnsiString

Index

Constructors

Accessors

Methods

add toString wrap

Constructors

constructor

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

Accessors

message

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

Methods

add

add(phrase: string, flags?: FormattingFlags, sty?: Style, ...args: Args): this
Appends a ANSI string formatted from a phrase, with a trailing line feed.
Parameters
- phrase: string
  The phrase text
- Optionalflags: FormattingFlags
  The formatting flags
- Optionalsty: Style
  The style, if any
- ...args: Args
  The phrase arguments
Returns this
The ANSI message instance
- Defined in packages/tsargp/src/library/styles.ts:923

toString

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

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
- Defined in packages/tsargp/src/library/styles.ts:902