Class: PreconditionError
Errors thrown by preconditions
Hierarchy
↳
PreconditionError
Constructors
constructor
• new PreconditionError(options
)
Parameters
Name | Type |
---|---|
options | Options |
Overrides
Defined in
projects/framework/src/lib/errors/PreconditionError.ts:11
Properties
cause
• Optional
cause: unknown
Inherited from
Defined in
node_modules/typescript/lib/lib.es2022.error.d.ts:24
context
• Readonly
context: unknown
User-provided context.
Inherited from
Defined in
projects/framework/src/lib/errors/UserError.ts:14
identifier
• Readonly
identifier: string
An identifier, useful to localize emitted errors.
Inherited from
Defined in
projects/framework/src/lib/errors/UserError.ts:9
message
• message: string
Inherited from
Defined in
node_modules/typescript/lib/lib.es5.d.ts:1055
precondition
• Readonly
precondition: Precondition
<PreconditionOptions
>
Defined in
projects/framework/src/lib/errors/PreconditionError.ts:9
stack
• Optional
stack: string
Inherited from
Defined in
node_modules/typescript/lib/lib.es5.d.ts:1056
prepareStackTrace
▪ Static
Optional
prepareStackTrace: (err
: Error
, stackTraces
: CallSite
[]) => any
Type declaration
▸ (err
, stackTraces
): any
Optional override for formatting stack traces
See
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
Parameters
Name | Type |
---|---|
err | Error |
stackTraces | CallSite [] |
Returns
any
Inherited from
Defined in
node_modules/@types/node/globals.d.ts:11
stackTraceLimit
▪ Static
stackTraceLimit: number
Inherited from
Defined in
node_modules/@types/node/globals.d.ts:13
Accessors
name
• get
name(): string
This will be 'PreconditionError'
and can be used to distinguish the type of error when any error gets thrown
Returns
string
Overrides
UserError.name
Defined in
projects/framework/src/lib/errors/PreconditionError.ts:17
Methods
captureStackTrace
▸ Static
captureStackTrace(targetObject
, constructorOpt?
): void
Create .stack property on a target object
Parameters
Name | Type |
---|---|
targetObject | object |
constructorOpt? | Function |
Returns
void
Inherited from
Defined in
node_modules/@types/node/globals.d.ts:4