Class PreconditionFailure

Error type produced whenever a precondition fails

Remarks

Since 2.2.0

Hierarchy

Error
- PreconditionFailure

Index

Constructors

Properties

interruptExecution message name stack? prepareStackTrace? stackTraceLimit

Methods

captureStackTrace isFailure

Constructors

constructor

new PreconditionFailure(interruptExecution?: boolean): PreconditionFailure
Parameters
- interruptExecution: boolean = false
Returns PreconditionFailure
Overrides Error.constructor
- Defined in packages/fast-check/src/check/precondition/PreconditionFailure.ts:11

Properties

`Readonly`interruptExecution

interruptExecution: boolean = false

message

message: string

name

name: string

`Optional`stack

stack?: string

`Static` `Optional`prepareStackTrace

prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

Optional override for formatting stack traces

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

`Static`stackTraceLimit

stackTraceLimit: number

Methods

`Static`captureStackTrace

captureStackTrace(targetObject: object, constructorOpt?: Function): void
Create .stack property on a target object
Parameters
- targetObject: object
- OptionalconstructorOpt: Function
Returns void
Inherited from Error.captureStackTrace
- Defined in node_modules/@types/node/globals.d.ts:21

`Static`isFailure

isFailure(err: unknown): err is PreconditionFailure
Parameters
- err: unknown
Returns err is PreconditionFailure
- Defined in packages/fast-check/src/check/precondition/PreconditionFailure.ts:15