Class AnsiMessage

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

Hierarchy (view full)

Array<TerminalString>
- AnsiMessage
  - WarnMessage

Index

Constructors

Accessors

Methods

Constructors

constructor

new AnsiMessage(arrayLength): AnsiMessage
Parameters
- arrayLength: number
Returns AnsiMessage
Inherited from Array<TerminalString>.constructor
- Defined in node_modules/typescript/lib/lib.es5.d.ts:1508
new AnsiMessage(...items): AnsiMessage
Parameters
- Rest ...items: TerminalString[]
Returns AnsiMessage
Inherited from Array<TerminalString>.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/lib/styles.ts:685

Methods

toString

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

wrap

wrap(width?, emitStyles?): string
Wraps the help message to a specified width.
Parameters
- width: number = 0
  The terminal width (or zero to avoid wrapping)
- emitStyles: boolean = !omitStyles(width)
  True if styles should be emitted
Returns string
The message to be printed on a terminal
- Defined in packages/tsargp/lib/styles.ts:663