vigiles API reference
    Preparing search index...

    Interface HookPropertyResult<E>

    Result of propertyHook: the first shrunk counterexample, if any.

    interface HookPropertyResult<E> {
        counterexample?: E;
        failedInvariant?: string;
        iterations: number;
        passed: boolean;
    }

    Type Parameters

    • E
    Index

    Properties

    counterexample?: E

    The (shrunk) event that broke an invariant — present iff !passed.

    failedInvariant?: string

    Which invariant failed — present iff !passed.

    iterations: number
    passed: boolean