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 }
});
Hierarchy
-
↳
UserError
Constructors
constructor
• new UserError(options): UserError
Constructs an UserError.
Parameters
| Name | Type | Description |
|---|---|---|
options | Options | The UserError options |
Returns
Overrides
Error.constructor
Defined in
projects/framework/src/lib/errors/UserError.ts:28
Properties
cause
• Optional cause: unknown
Inherited from
Error.cause
Defined in
node_modules/typescript/lib/lib.es2022.error.d.ts:24
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
message
• message: string
Inherited from
Error.message
Defined in
node_modules/typescript/lib/lib.es5.d.ts:1077
stack
• Optional stack: string
Inherited from
Error.stack
Defined in
node_modules/typescript/lib/lib.es5.d.ts:1078
prepareStackTrace
▪ Static Optional prepareStackTrace: (err: Error, stackTraces: CallSite[]) => any
Optional override for formatting stack traces
See
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
Type declaration
▸ (err, stackTraces): any
Parameters
| Name | Type |
|---|---|
err | Error |
stackTraces | CallSite[] |
Returns
any
Inherited from
Error.prepareStackTrace
Defined in
node_modules/@types/node/globals.d.ts:28
stackTraceLimit
▪ Static stackTraceLimit: number
Inherited from
Error.stackTraceLimit
Defined in
node_modules/@types/node/globals.d.ts:30
Accessors
name
• get name(): string
This will be 'UserError' and can be used to distinguish the type of error when any error gets thrown
Returns
string
Overrides
Error.name
Defined in
projects/framework/src/lib/errors/UserError.ts:35
Methods
captureStackTrace
▸ captureStackTrace(targetObject, constructorOpt?): void
Create .stack property on a target object
Parameters
| Name | Type |
|---|---|
targetObject | object |
constructorOpt? | Function |
Returns
void
Inherited from
Error.captureStackTrace
Defined in
node_modules/@types/node/globals.d.ts:21