Class WarnMessage

A warning message.

Hierarchy (View Summary)

AnsiMessage
- WarnMessage

Indexable

[n: number]: AnsiString

Index

Constructors

Accessors

Methods

add addCustom toString wrap

Constructors

constructor

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

Methods

add

add(kind: ErrorItem, flags?: FormattingFlags, ...args: Args): void
Appends a ANSI message formatted from an error phrase.
Parameters
- kind: ErrorItem
  The error kind
- Optionalflags: FormattingFlags
  The formatting flags
- ...args: Args
  The error arguments
Returns void
- Defined in packages/tsargp/lib/styles.ts:778

addCustom

addCustom(phrase: string, flags?: FormattingFlags, ...args: Args): void
Appends a ANSI string formatted from a custom phrase.
Parameters
- phrase: string
  The phrase
- Optionalflags: FormattingFlags
  The formatting flags
- ...args: Args
  The phrase arguments
Returns void
- Defined in packages/tsargp/lib/styles.ts:788

toString

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

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/lib/styles.ts:740