Class ErrorMessage

An error message.

Hierarchy

Error
- ErrorMessage

Index

Constructors

Properties

Accessors

Methods

toString create createCustom

Constructors

constructor

new ErrorMessage(message?: string): ErrorMessage
Parameters
- Optionalmessage: string
Returns ErrorMessage
Inherited from Error.constructor
- Defined in node_modules/typescript/lib/lib.es5.d.ts:1082
new ErrorMessage(message?: string, options?: ErrorOptions): ErrorMessage
Parameters
- Optionalmessage: string
- Optionaloptions: ErrorOptions
Returns ErrorMessage
Inherited from Error.constructor
- Defined in node_modules/typescript/lib/lib.es5.d.ts:1082

Properties

`Readonly`msg

msg: WarnMessage = ...

The warning message.

Accessors

message

get message(): string
Returns string
The wrapped message
Overrides Error.message
- Defined in packages/tsargp/lib/styles.ts:821

Methods

toString

toString(): string
We have to override this, since the message cannot be transformed after being wrapped.

Returns string
The wrapped message
- Defined in packages/tsargp/lib/styles.ts:814

`Static`create

create(kind: ErrorItem, flags?: FormattingFlags, ...args: Args): ErrorMessage
Creates an error message formatted with an error phrase.
Parameters
- kind: ErrorItem
  The error kind
- Optionalflags: FormattingFlags
  The formatting flags
- ...args: Args
  The error arguments
Returns ErrorMessage
The newly created message
- Defined in packages/tsargp/lib/styles.ts:832

`Static`createCustom

createCustom(
    phrase: string,
    flags?: FormattingFlags,
    ...args: Args,
): ErrorMessage
Creates an error message formatted with a custom phrase.
Parameters
- phrase: string
  The phrase
- Optionalflags: FormattingFlags
  The formatting flags
- ...args: Args
  The phrase arguments
Returns ErrorMessage
The newly created message
- Defined in packages/tsargp/lib/styles.ts:845