Class: UserError

The UserError class to be emitted in the pieces.

Example

throw new UserError({
  identifier: 'AddArgumentError',
  message: 'You must write two numbers, but the second one did not match.',
  context: { received: 2, expected: 3 }
});

Extends

• Error

Extended by

• ArgumentError
• PreconditionError

Constructors

new UserError()

new UserError(options: Options): UserError

Constructs an UserError.

Parameters

Parameter	Type	Description
options	Options	The UserError options

Returns

UserError

Overrides

Error.constructor

Defined in

projects/framework/src/lib/errors/UserError.ts:28

Properties

context

readonly context: unknown

User-provided context.

Defined in

projects/framework/src/lib/errors/UserError.ts:22

---

identifier

readonly identifier: string

An identifier, useful to localize emitted errors.

Defined in

projects/framework/src/lib/errors/UserError.ts:17

Accessors

name

get name(): string

Returns

string

Overrides

Error.name

Defined in

projects/framework/src/lib/errors/UserError.ts:35