Class PreconditionFailure

Error type produced whenever a precondition fails

Remarks

Since 2.2.0

Hierarchy

Error
- PreconditionFailure

Index

Constructors

Properties

footprint interruptExecution message name stack? SharedFootPrint prepareStackTrace? stackTraceLimit

Methods

captureStackTrace isFailure

Constructors

constructor

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

Properties

`Private` `Readonly` footprint

footprint: symbol

`Readonly` interruptExecution

interruptExecution: boolean = false

message

message: string

name

name: string

`Optional` stack

stack?: string

`Static` `Private` `Readonly` SharedFootPrint

SharedFootPrint: symbol = ...

`Static` `Optional` prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Type declaration

- (err, stackTraces): any
- Optional override for formatting stack traces
  Parameters
  - err: Error
  - stackTraces: CallSite[]
  Returns any
  See
  https://v8.dev/docs/stack-trace-api#customizing-stack-traces

`Static` stackTraceLimit

stackTraceLimit: number

Methods

`Static` captureStackTrace

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

`Static` isFailure

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

Generated using TypeDoc