Node TAP
    Preparing search index...

    Hierarchy

    • Synonymized
      • Synonyms
    Index

    Constructors

    Assertion Methods

    assert assert_not assertnot assertNot contains deep_equal deep_equals deep_inequal deep_is deep_not deepequal deepEqual deepequals deepEquals deepinequal deepInequal deepis deepIs deepnot deepNot dissimilar does_not_equal does_not_have does_not_throw doesnotequal doesNotEqual doesnothave doesNotHave doesnotthrow equals equivalent false has_fields hasfields hasFields identical if_err if_error iferr ifErr iferror ifError include includes inequal inequivalent is is_a is_deep is_deeply is_dissimilar is_equal is_equivalent is_inequal is_inequivalent is_like is_loose is_not is_not_deep_equal is_not_deeply is_not_equal is_not_equivalent is_not_like is_not_similar is_similar is_strict is_strictly is_unlike isa isA isdeep isDeep isdeeply isDeeply isdissimilar isDissimilar isequal isEqual isequivalent isEquivalent isinequal isInequal isinequivalent isInequivalent islike isLike isloose isLoose isnot isNot isnotdeepequal isNotDeepEqual isnotdeeply isNotDeeply isnotequal isNotEqual isnotequivalent isNotEquivalent isnotlike isNotLike isnotsimilar isNotSimilar issimilar isSimilar isstrict isStrict isstrictly isStrictly isunlike isUnlike like loose_equal loose_equals loose_inequal loose_is loose_not looseequal looseEqual looseequals looseEquals looseinequal looseInequal looseis looseIs loosenot looseNot matches not_deep not_deep_equal not_deeply not_equal not_equals not_equivalent not_like not_loose not_match not_ok not_same not_same_strict not_similar not_strict_equal not_strict_equals not_strict_same not_throw notdeep notDeep notdeepequal notDeepEqual notdeeply notDeeply notequal notEqual notequals notEquals notequivalent notEquivalent notlike notLike notloose notLoose notmatch notok notsame notsamestrict notSameStrict notsimilar notSimilar notstrictequal notStrictEqual notstrictequals notStrictEquals notstrictsame notStrictSame notthrow notThrow same_strict samestrict sameStrict similar strict_deep_equal strict_deep_equals strict_deep_inequal strict_deep_inequals strict_equal strict_equals strict_equivalent strict_inequivalent strict_is strict_not_same strict_same strictdeepequal strictDeepEqual strictdeepequals strictDeepEquals strictdeepinequal strictDeepInequal strictdeepinequals strictDeepInequals strictequal strictEqual strictequals strictEquals strictequivalent strictEquivalent strictinequivalent strictInequivalent strictis strictIs strictnotsame strictsame throw true unlike unsimilar

    Test Lifecycle Management

    Constructors

    Assertion Methods

    assert: (obj: any, ...__namedParameters: MessageExtra) => boolean = ...

    Type Declaration

      • (obj: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value is truthy

        Parameters

        Returns boolean

    assert_not: (obj: any, ...__namedParameters: MessageExtra) => boolean = ...

    Type Declaration

      • (obj: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value is not truthy

        Parameters

        Returns boolean

    assertnot: (obj: any, ...__namedParameters: MessageExtra) => boolean = ...

    Type Declaration

      • (obj: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value is not truthy

        Parameters

        Returns boolean

    assertNot: (obj: any, ...__namedParameters: MessageExtra) => boolean = ...

    Type Declaration

      • (obj: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value is not truthy

        Parameters

        Returns boolean

    contains: (
        found: any,
        wanted: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, wanted: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the object has all of the properties and values in the pattern, matching loosely.

        Parameters

        Returns boolean

    deep_equal: (
        found: any,
        wanted: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, wanted: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value is loosely equivalent to the supplied pattern

        Parameters

        Returns boolean

    deep_equals: (
        found: any,
        wanted: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, wanted: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value is loosely equivalent to the supplied pattern

        Parameters

        Returns boolean

    deep_inequal: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value is not loosely equivalent to the supplied pattern

        Parameters

        Returns boolean

    deep_is: <T extends unknown>(
        found: any,
        wanted: T,
        ...__namedParameters: MessageExtra,
    ) => found is T = ...

    Type Declaration

      • <T extends unknown>(
            found: any,
            wanted: T,
            ...__namedParameters: MessageExtra,
        ): found is T
      • Verify that the value is strictly equivalent to the supplied pattern

        Type Parameters

        • T extends unknown

        Parameters

        Returns found is T

    deep_not: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value is not strictly equivalent to the supplied pattern object

        Parameters

        Returns boolean

    deepequal: (
        found: any,
        wanted: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, wanted: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value is loosely equivalent to the supplied pattern

        Parameters

        Returns boolean

    deepEqual: (
        found: any,
        wanted: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, wanted: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value is loosely equivalent to the supplied pattern

        Parameters

        Returns boolean

    deepequals: (
        found: any,
        wanted: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, wanted: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value is loosely equivalent to the supplied pattern

        Parameters

        Returns boolean

    deepEquals: (
        found: any,
        wanted: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, wanted: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value is loosely equivalent to the supplied pattern

        Parameters

        Returns boolean

    deepinequal: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value is not loosely equivalent to the supplied pattern

        Parameters

        Returns boolean

    deepInequal: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value is not loosely equivalent to the supplied pattern

        Parameters

        Returns boolean

    deepis: <T extends unknown>(
        found: any,
        wanted: T,
        ...__namedParameters: MessageExtra,
    ) => found is T = ...

    Type Declaration

      • <T extends unknown>(
            found: any,
            wanted: T,
            ...__namedParameters: MessageExtra,
        ): found is T
      • Verify that the value is strictly equivalent to the supplied pattern

        Type Parameters

        • T extends unknown

        Parameters

        Returns found is T

    deepIs: <T extends unknown>(
        found: any,
        wanted: T,
        ...__namedParameters: MessageExtra,
    ) => found is T = ...

    Type Declaration

      • <T extends unknown>(
            found: any,
            wanted: T,
            ...__namedParameters: MessageExtra,
        ): found is T
      • Verify that the value is strictly equivalent to the supplied pattern

        Type Parameters

        • T extends unknown

        Parameters

        Returns found is T

    deepnot: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value is not strictly equivalent to the supplied pattern object

        Parameters

        Returns boolean

    deepNot: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value is not strictly equivalent to the supplied pattern object

        Parameters

        Returns boolean

    dissimilar: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value does NOT match the pattern provided.

        Parameters

        Returns boolean

    does_not_equal: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the values are not equal

        Parameters

        Returns boolean

    does_not_have: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value does NOT match the pattern provided.

        Parameters

        Returns boolean

    does_not_throw: (
        fn: Function | (() => any),
        ...__namedParameters: MessageExtra,
    ) => boolean | Error = ...

    Type Declaration

      • (
            fn: Function | (() => any),
            ...__namedParameters: MessageExtra,
        ): boolean | Error
      • Returns the error object if it throws and that does not fail the test (by virtue of being marked skip or todo). Otherwise returns the passing status, like other assertions.

        Parameters

        • fn: Function | (() => any)
        • ...__namedParameters: MessageExtra

        Returns boolean | Error

    doesnotequal: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the values are not equal

        Parameters

        Returns boolean

    doesNotEqual: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the values are not equal

        Parameters

        Returns boolean

    doesnothave: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value does NOT match the pattern provided.

        Parameters

        Returns boolean

    doesNotHave: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value does NOT match the pattern provided.

        Parameters

        Returns boolean

    doesnotthrow: (
        fn: Function | (() => any),
        ...__namedParameters: MessageExtra,
    ) => boolean | Error = ...

    Type Declaration

      • (
            fn: Function | (() => any),
            ...__namedParameters: MessageExtra,
        ): boolean | Error
      • Returns the error object if it throws and that does not fail the test (by virtue of being marked skip or todo). Otherwise returns the passing status, like other assertions.

        Parameters

        • fn: Function | (() => any)
        • ...__namedParameters: MessageExtra

        Returns boolean | Error

    equals: <T extends unknown>(
        found: any,
        wanted: T,
        ...__namedParameters: MessageExtra,
    ) => found is T = ...

    Type Declaration

      • <T extends unknown>(
            found: any,
            wanted: T,
            ...__namedParameters: MessageExtra,
        ): found is T
      • Verify that the values are equal

        Type Parameters

        • T extends unknown

        Parameters

        Returns found is T

    equivalent: (
        found: any,
        wanted: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, wanted: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value is loosely equivalent to the supplied pattern

        Parameters

        Returns boolean

    false: (obj: any, ...__namedParameters: MessageExtra) => boolean = ...

    Type Declaration

      • (obj: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value is not truthy

        Parameters

        Returns boolean

    has_fields: (
        found: any,
        wanted: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, wanted: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the object has all of the properties and values in the pattern, matching loosely.

        Parameters

        Returns boolean

    hasfields: (
        found: any,
        wanted: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, wanted: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the object has all of the properties and values in the pattern, matching loosely.

        Parameters

        Returns boolean

    hasFields: (
        found: any,
        wanted: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, wanted: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the object has all of the properties and values in the pattern, matching loosely.

        Parameters

        Returns boolean

    identical: <T extends unknown>(
        found: any,
        wanted: T,
        ...__namedParameters: MessageExtra,
    ) => found is T = ...

    Type Declaration

      • <T extends unknown>(
            found: any,
            wanted: T,
            ...__namedParameters: MessageExtra,
        ): found is T
      • Verify that the values are equal

        Type Parameters

        • T extends unknown

        Parameters

        Returns found is T

    if_err: (er: unknown, ...__namedParameters: MessageExtra) => boolean = ...

    Type Declaration

    if_error: (er: unknown, ...__namedParameters: MessageExtra) => boolean = ...

    Type Declaration

    iferr: (er: unknown, ...__namedParameters: MessageExtra) => boolean = ...

    Type Declaration

    ifErr: (er: unknown, ...__namedParameters: MessageExtra) => boolean = ...

    Type Declaration

    iferror: (er: unknown, ...__namedParameters: MessageExtra) => boolean = ...

    Type Declaration

    ifError: (er: unknown, ...__namedParameters: MessageExtra) => boolean = ...

    Type Declaration

    include: (
        found: any,
        wanted: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, wanted: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the object has all of the properties and values in the pattern, matching loosely.

        Parameters

        Returns boolean

    includes: (
        found: any,
        wanted: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, wanted: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the object has all of the properties and values in the pattern, matching loosely.

        Parameters

        Returns boolean

    inequal: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the values are not equal

        Parameters

        Returns boolean

    inequivalent: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value is not loosely equivalent to the supplied pattern

        Parameters

        Returns boolean

    is: <T extends unknown>(
        found: any,
        wanted: T,
        ...__namedParameters: MessageExtra,
    ) => found is T = ...

    Type Declaration

      • <T extends unknown>(
            found: any,
            wanted: T,
            ...__namedParameters: MessageExtra,
        ): found is T
      • Verify that the values are equal

        Type Parameters

        • T extends unknown

        Parameters

        Returns found is T

    is_a: (
        obj: any,
        klass: string | Function,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (
            obj: any,
            klass: string | Function,
            ...__namedParameters: MessageExtra,
        ): boolean
      • Verify that the value is of the type specified Type can be either a string, or a constructor.

        If a string, then it can match either the typeof result or 'null' for null values, or the name property of the object's constructor.

        Parameters

        • obj: any
        • klass: string | Function
        • ...__namedParameters: MessageExtra

        Returns boolean

    is_deep: <T extends unknown>(
        found: any,
        wanted: T,
        ...__namedParameters: MessageExtra,
    ) => found is T = ...

    Type Declaration

      • <T extends unknown>(
            found: any,
            wanted: T,
            ...__namedParameters: MessageExtra,
        ): found is T
      • Verify that the value is strictly equivalent to the supplied pattern

        Type Parameters

        • T extends unknown

        Parameters

        Returns found is T

    is_deeply: <T extends unknown>(
        found: any,
        wanted: T,
        ...__namedParameters: MessageExtra,
    ) => found is T = ...

    Type Declaration

      • <T extends unknown>(
            found: any,
            wanted: T,
            ...__namedParameters: MessageExtra,
        ): found is T
      • Verify that the value is strictly equivalent to the supplied pattern

        Type Parameters

        • T extends unknown

        Parameters

        Returns found is T

    is_dissimilar: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value does NOT match the pattern provided.

        Parameters

        Returns boolean

    is_equal: <T extends unknown>(
        found: any,
        wanted: T,
        ...__namedParameters: MessageExtra,
    ) => found is T = ...

    Type Declaration

      • <T extends unknown>(
            found: any,
            wanted: T,
            ...__namedParameters: MessageExtra,
        ): found is T
      • Verify that the values are equal

        Type Parameters

        • T extends unknown

        Parameters

        Returns found is T

    is_equivalent: (
        found: any,
        wanted: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, wanted: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value is loosely equivalent to the supplied pattern

        Parameters

        Returns boolean

    is_inequal: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the values are not equal

        Parameters

        Returns boolean

    is_inequivalent: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value is not loosely equivalent to the supplied pattern

        Parameters

        Returns boolean

    is_like: (
        found: any,
        wanted: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, wanted: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value matches the pattern provided

        Parameters

        Returns boolean

    is_loose: (
        found: any,
        wanted: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, wanted: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value is loosely equivalent to the supplied pattern

        Parameters

        Returns boolean

    is_not: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the values are not equal

        Parameters

        Returns boolean

    is_not_deep_equal: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value is not loosely equivalent to the supplied pattern

        Parameters

        Returns boolean

    is_not_deeply: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value is not loosely equivalent to the supplied pattern

        Parameters

        Returns boolean

    is_not_equal: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the values are not equal

        Parameters

        Returns boolean

    is_not_equivalent: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value is not loosely equivalent to the supplied pattern

        Parameters

        Returns boolean

    is_not_like: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value does NOT match the pattern provided.

        Parameters

        Returns boolean

    is_not_similar: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value does NOT match the pattern provided.

        Parameters

        Returns boolean

    is_similar: (
        found: any,
        wanted: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, wanted: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value matches the pattern provided

        Parameters

        Returns boolean

    is_strict: <T extends unknown>(
        found: any,
        wanted: T,
        ...__namedParameters: MessageExtra,
    ) => found is T = ...

    Type Declaration

      • <T extends unknown>(
            found: any,
            wanted: T,
            ...__namedParameters: MessageExtra,
        ): found is T
      • Verify that the values are equal

        Type Parameters

        • T extends unknown

        Parameters

        Returns found is T

    is_strictly: <T extends unknown>(
        found: any,
        wanted: T,
        ...__namedParameters: MessageExtra,
    ) => found is T = ...

    Type Declaration

      • <T extends unknown>(
            found: any,
            wanted: T,
            ...__namedParameters: MessageExtra,
        ): found is T
      • Verify that the values are equal

        Type Parameters

        • T extends unknown

        Parameters

        Returns found is T

    is_unlike: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value does NOT match the pattern provided.

        Parameters

        Returns boolean

    isa: (
        obj: any,
        klass: string | Function,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (
            obj: any,
            klass: string | Function,
            ...__namedParameters: MessageExtra,
        ): boolean
      • Verify that the value is of the type specified Type can be either a string, or a constructor.

        If a string, then it can match either the typeof result or 'null' for null values, or the name property of the object's constructor.

        Parameters

        • obj: any
        • klass: string | Function
        • ...__namedParameters: MessageExtra

        Returns boolean

    isA: (
        obj: any,
        klass: string | Function,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (
            obj: any,
            klass: string | Function,
            ...__namedParameters: MessageExtra,
        ): boolean
      • Verify that the value is of the type specified Type can be either a string, or a constructor.

        If a string, then it can match either the typeof result or 'null' for null values, or the name property of the object's constructor.

        Parameters

        • obj: any
        • klass: string | Function
        • ...__namedParameters: MessageExtra

        Returns boolean

    isdeep: <T extends unknown>(
        found: any,
        wanted: T,
        ...__namedParameters: MessageExtra,
    ) => found is T = ...

    Type Declaration

      • <T extends unknown>(
            found: any,
            wanted: T,
            ...__namedParameters: MessageExtra,
        ): found is T
      • Verify that the value is strictly equivalent to the supplied pattern

        Type Parameters

        • T extends unknown

        Parameters

        Returns found is T

    isDeep: <T extends unknown>(
        found: any,
        wanted: T,
        ...__namedParameters: MessageExtra,
    ) => found is T = ...

    Type Declaration

      • <T extends unknown>(
            found: any,
            wanted: T,
            ...__namedParameters: MessageExtra,
        ): found is T
      • Verify that the value is strictly equivalent to the supplied pattern

        Type Parameters

        • T extends unknown

        Parameters

        Returns found is T

    isdeeply: <T extends unknown>(
        found: any,
        wanted: T,
        ...__namedParameters: MessageExtra,
    ) => found is T = ...

    Type Declaration

      • <T extends unknown>(
            found: any,
            wanted: T,
            ...__namedParameters: MessageExtra,
        ): found is T
      • Verify that the value is strictly equivalent to the supplied pattern

        Type Parameters

        • T extends unknown

        Parameters

        Returns found is T

    isDeeply: <T extends unknown>(
        found: any,
        wanted: T,
        ...__namedParameters: MessageExtra,
    ) => found is T = ...

    Type Declaration

      • <T extends unknown>(
            found: any,
            wanted: T,
            ...__namedParameters: MessageExtra,
        ): found is T
      • Verify that the value is strictly equivalent to the supplied pattern

        Type Parameters

        • T extends unknown

        Parameters

        Returns found is T

    isdissimilar: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value does NOT match the pattern provided.

        Parameters

        Returns boolean

    isDissimilar: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value does NOT match the pattern provided.

        Parameters

        Returns boolean

    isequal: <T extends unknown>(
        found: any,
        wanted: T,
        ...__namedParameters: MessageExtra,
    ) => found is T = ...

    Type Declaration

      • <T extends unknown>(
            found: any,
            wanted: T,
            ...__namedParameters: MessageExtra,
        ): found is T
      • Verify that the values are equal

        Type Parameters

        • T extends unknown

        Parameters

        Returns found is T

    isEqual: <T extends unknown>(
        found: any,
        wanted: T,
        ...__namedParameters: MessageExtra,
    ) => found is T = ...

    Type Declaration

      • <T extends unknown>(
            found: any,
            wanted: T,
            ...__namedParameters: MessageExtra,
        ): found is T
      • Verify that the values are equal

        Type Parameters

        • T extends unknown

        Parameters

        Returns found is T

    isequivalent: (
        found: any,
        wanted: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, wanted: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value is loosely equivalent to the supplied pattern

        Parameters

        Returns boolean

    isEquivalent: (
        found: any,
        wanted: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, wanted: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value is loosely equivalent to the supplied pattern

        Parameters

        Returns boolean

    isinequal: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the values are not equal

        Parameters

        Returns boolean

    isInequal: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the values are not equal

        Parameters

        Returns boolean

    isinequivalent: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value is not loosely equivalent to the supplied pattern

        Parameters

        Returns boolean

    isInequivalent: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value is not loosely equivalent to the supplied pattern

        Parameters

        Returns boolean

    islike: (found: any, wanted: any, ...__namedParameters: MessageExtra) => boolean = ...

    Type Declaration

      • (found: any, wanted: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value matches the pattern provided

        Parameters

        Returns boolean

    isLike: (found: any, wanted: any, ...__namedParameters: MessageExtra) => boolean = ...

    Type Declaration

      • (found: any, wanted: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value matches the pattern provided

        Parameters

        Returns boolean

    isloose: (
        found: any,
        wanted: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, wanted: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value is loosely equivalent to the supplied pattern

        Parameters

        Returns boolean

    isLoose: (
        found: any,
        wanted: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, wanted: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value is loosely equivalent to the supplied pattern

        Parameters

        Returns boolean

    isnot: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the values are not equal

        Parameters

        Returns boolean

    isNot: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the values are not equal

        Parameters

        Returns boolean

    isnotdeepequal: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value is not loosely equivalent to the supplied pattern

        Parameters

        Returns boolean

    isNotDeepEqual: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value is not loosely equivalent to the supplied pattern

        Parameters

        Returns boolean

    isnotdeeply: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value is not loosely equivalent to the supplied pattern

        Parameters

        Returns boolean

    isNotDeeply: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value is not loosely equivalent to the supplied pattern

        Parameters

        Returns boolean

    isnotequal: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the values are not equal

        Parameters

        Returns boolean

    isNotEqual: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the values are not equal

        Parameters

        Returns boolean

    isnotequivalent: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value is not loosely equivalent to the supplied pattern

        Parameters

        Returns boolean

    isNotEquivalent: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value is not loosely equivalent to the supplied pattern

        Parameters

        Returns boolean

    isnotlike: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value does NOT match the pattern provided.

        Parameters

        Returns boolean

    isNotLike: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value does NOT match the pattern provided.

        Parameters

        Returns boolean

    isnotsimilar: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value does NOT match the pattern provided.

        Parameters

        Returns boolean

    isNotSimilar: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value does NOT match the pattern provided.

        Parameters

        Returns boolean

    issimilar: (
        found: any,
        wanted: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, wanted: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value matches the pattern provided

        Parameters

        Returns boolean

    isSimilar: (
        found: any,
        wanted: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, wanted: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value matches the pattern provided

        Parameters

        Returns boolean

    isstrict: <T extends unknown>(
        found: any,
        wanted: T,
        ...__namedParameters: MessageExtra,
    ) => found is T = ...

    Type Declaration

      • <T extends unknown>(
            found: any,
            wanted: T,
            ...__namedParameters: MessageExtra,
        ): found is T
      • Verify that the values are equal

        Type Parameters

        • T extends unknown

        Parameters

        Returns found is T

    isStrict: <T extends unknown>(
        found: any,
        wanted: T,
        ...__namedParameters: MessageExtra,
    ) => found is T = ...

    Type Declaration

      • <T extends unknown>(
            found: any,
            wanted: T,
            ...__namedParameters: MessageExtra,
        ): found is T
      • Verify that the values are equal

        Type Parameters

        • T extends unknown

        Parameters

        Returns found is T

    isstrictly: <T extends unknown>(
        found: any,
        wanted: T,
        ...__namedParameters: MessageExtra,
    ) => found is T = ...

    Type Declaration

      • <T extends unknown>(
            found: any,
            wanted: T,
            ...__namedParameters: MessageExtra,
        ): found is T
      • Verify that the values are equal

        Type Parameters

        • T extends unknown

        Parameters

        Returns found is T

    isStrictly: <T extends unknown>(
        found: any,
        wanted: T,
        ...__namedParameters: MessageExtra,
    ) => found is T = ...

    Type Declaration

      • <T extends unknown>(
            found: any,
            wanted: T,
            ...__namedParameters: MessageExtra,
        ): found is T
      • Verify that the values are equal

        Type Parameters

        • T extends unknown

        Parameters

        Returns found is T

    isunlike: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value does NOT match the pattern provided.

        Parameters

        Returns boolean

    isUnlike: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value does NOT match the pattern provided.

        Parameters

        Returns boolean

    like: (found: any, wanted: any, ...__namedParameters: MessageExtra) => boolean = ...

    Type Declaration

      • (found: any, wanted: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value matches the pattern provided

        Parameters

        Returns boolean

    loose_equal: (
        found: any,
        wanted: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, wanted: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value is loosely equivalent to the supplied pattern

        Parameters

        Returns boolean

    loose_equals: (
        found: any,
        wanted: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, wanted: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value is loosely equivalent to the supplied pattern

        Parameters

        Returns boolean

    loose_inequal: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value is not loosely equivalent to the supplied pattern

        Parameters

        Returns boolean

    loose_is: (
        found: any,
        wanted: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, wanted: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value is loosely equivalent to the supplied pattern

        Parameters

        Returns boolean

    loose_not: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value is not loosely equivalent to the supplied pattern

        Parameters

        Returns boolean

    looseequal: (
        found: any,
        wanted: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, wanted: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value is loosely equivalent to the supplied pattern

        Parameters

        Returns boolean

    looseEqual: (
        found: any,
        wanted: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, wanted: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value is loosely equivalent to the supplied pattern

        Parameters

        Returns boolean

    looseequals: (
        found: any,
        wanted: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, wanted: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value is loosely equivalent to the supplied pattern

        Parameters

        Returns boolean

    looseEquals: (
        found: any,
        wanted: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, wanted: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value is loosely equivalent to the supplied pattern

        Parameters

        Returns boolean

    looseinequal: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value is not loosely equivalent to the supplied pattern

        Parameters

        Returns boolean

    looseInequal: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value is not loosely equivalent to the supplied pattern

        Parameters

        Returns boolean

    looseis: (
        found: any,
        wanted: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, wanted: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value is loosely equivalent to the supplied pattern

        Parameters

        Returns boolean

    looseIs: (
        found: any,
        wanted: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, wanted: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value is loosely equivalent to the supplied pattern

        Parameters

        Returns boolean

    loosenot: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value is not loosely equivalent to the supplied pattern

        Parameters

        Returns boolean

    looseNot: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value is not loosely equivalent to the supplied pattern

        Parameters

        Returns boolean

    matches: (
        found: any,
        wanted: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, wanted: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value matches the pattern provided

        Parameters

        Returns boolean

    not_deep: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value is not loosely equivalent to the supplied pattern

        Parameters

        Returns boolean

    not_deep_equal: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value is not loosely equivalent to the supplied pattern

        Parameters

        Returns boolean

    not_deeply: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value is not strictly equivalent to the supplied pattern object

        Parameters

        Returns boolean

    not_equal: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the values are not equal

        Parameters

        Returns boolean

    not_equals: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the values are not equal

        Parameters

        Returns boolean

    not_equivalent: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value is not loosely equivalent to the supplied pattern

        Parameters

        Returns boolean

    not_like: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value does NOT match the pattern provided.

        Parameters

        Returns boolean

    not_loose: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value is not loosely equivalent to the supplied pattern

        Parameters

        Returns boolean

    not_match: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value does NOT match the pattern provided.

        Parameters

        Returns boolean

    not_ok: (obj: any, ...__namedParameters: MessageExtra) => boolean = ...

    Type Declaration

      • (obj: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value is not truthy

        Parameters

        Returns boolean

    not_same: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value is not loosely equivalent to the supplied pattern

        Parameters

        Returns boolean

    not_same_strict: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value is not strictly equivalent to the supplied pattern object

        Parameters

        Returns boolean

    not_similar: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value does NOT match the pattern provided.

        Parameters

        Returns boolean

    not_strict_equal: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the values are not equal

        Parameters

        Returns boolean

    not_strict_equals: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the values are not equal

        Parameters

        Returns boolean

    not_strict_same: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value is not strictly equivalent to the supplied pattern object

        Parameters

        Returns boolean

    not_throw: (
        fn: Function | (() => any),
        ...__namedParameters: MessageExtra,
    ) => boolean | Error = ...

    Type Declaration

      • (
            fn: Function | (() => any),
            ...__namedParameters: MessageExtra,
        ): boolean | Error
      • Returns the error object if it throws and that does not fail the test (by virtue of being marked skip or todo). Otherwise returns the passing status, like other assertions.

        Parameters

        • fn: Function | (() => any)
        • ...__namedParameters: MessageExtra

        Returns boolean | Error

    notdeep: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value is not loosely equivalent to the supplied pattern

        Parameters

        Returns boolean

    notDeep: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value is not loosely equivalent to the supplied pattern

        Parameters

        Returns boolean

    notdeepequal: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value is not loosely equivalent to the supplied pattern

        Parameters

        Returns boolean

    notDeepEqual: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value is not loosely equivalent to the supplied pattern

        Parameters

        Returns boolean

    notdeeply: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value is not strictly equivalent to the supplied pattern object

        Parameters

        Returns boolean

    notDeeply: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value is not strictly equivalent to the supplied pattern object

        Parameters

        Returns boolean

    notequal: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the values are not equal

        Parameters

        Returns boolean

    notEqual: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the values are not equal

        Parameters

        Returns boolean

    notequals: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the values are not equal

        Parameters

        Returns boolean

    notEquals: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the values are not equal

        Parameters

        Returns boolean

    notequivalent: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value is not loosely equivalent to the supplied pattern

        Parameters

        Returns boolean

    notEquivalent: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value is not loosely equivalent to the supplied pattern

        Parameters

        Returns boolean

    notlike: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value does NOT match the pattern provided.

        Parameters

        Returns boolean

    notLike: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value does NOT match the pattern provided.

        Parameters

        Returns boolean

    notloose: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value is not loosely equivalent to the supplied pattern

        Parameters

        Returns boolean

    notLoose: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value is not loosely equivalent to the supplied pattern

        Parameters

        Returns boolean

    notmatch: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value does NOT match the pattern provided.

        Parameters

        Returns boolean

    notok: (obj: any, ...__namedParameters: MessageExtra) => boolean = ...

    Type Declaration

      • (obj: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value is not truthy

        Parameters

        Returns boolean

    notsame: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value is not loosely equivalent to the supplied pattern

        Parameters

        Returns boolean

    notsamestrict: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value is not strictly equivalent to the supplied pattern object

        Parameters

        Returns boolean

    notSameStrict: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value is not strictly equivalent to the supplied pattern object

        Parameters

        Returns boolean

    notsimilar: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value does NOT match the pattern provided.

        Parameters

        Returns boolean

    notSimilar: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value does NOT match the pattern provided.

        Parameters

        Returns boolean

    notstrictequal: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the values are not equal

        Parameters

        Returns boolean

    notStrictEqual: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the values are not equal

        Parameters

        Returns boolean

    notstrictequals: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the values are not equal

        Parameters

        Returns boolean

    notStrictEquals: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the values are not equal

        Parameters

        Returns boolean

    notstrictsame: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value is not strictly equivalent to the supplied pattern object

        Parameters

        Returns boolean

    notStrictSame: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value is not strictly equivalent to the supplied pattern object

        Parameters

        Returns boolean

    notthrow: (
        fn: Function | (() => any),
        ...__namedParameters: MessageExtra,
    ) => boolean | Error = ...

    Type Declaration

      • (
            fn: Function | (() => any),
            ...__namedParameters: MessageExtra,
        ): boolean | Error
      • Returns the error object if it throws and that does not fail the test (by virtue of being marked skip or todo). Otherwise returns the passing status, like other assertions.

        Parameters

        • fn: Function | (() => any)
        • ...__namedParameters: MessageExtra

        Returns boolean | Error

    notThrow: (
        fn: Function | (() => any),
        ...__namedParameters: MessageExtra,
    ) => boolean | Error = ...

    Type Declaration

      • (
            fn: Function | (() => any),
            ...__namedParameters: MessageExtra,
        ): boolean | Error
      • Returns the error object if it throws and that does not fail the test (by virtue of being marked skip or todo). Otherwise returns the passing status, like other assertions.

        Parameters

        • fn: Function | (() => any)
        • ...__namedParameters: MessageExtra

        Returns boolean | Error

    same_strict: <T extends unknown>(
        found: any,
        wanted: T,
        ...__namedParameters: MessageExtra,
    ) => found is T = ...

    Type Declaration

      • <T extends unknown>(
            found: any,
            wanted: T,
            ...__namedParameters: MessageExtra,
        ): found is T
      • Verify that the value is strictly equivalent to the supplied pattern

        Type Parameters

        • T extends unknown

        Parameters

        Returns found is T

    samestrict: <T extends unknown>(
        found: any,
        wanted: T,
        ...__namedParameters: MessageExtra,
    ) => found is T = ...

    Type Declaration

      • <T extends unknown>(
            found: any,
            wanted: T,
            ...__namedParameters: MessageExtra,
        ): found is T
      • Verify that the value is strictly equivalent to the supplied pattern

        Type Parameters

        • T extends unknown

        Parameters

        Returns found is T

    sameStrict: <T extends unknown>(
        found: any,
        wanted: T,
        ...__namedParameters: MessageExtra,
    ) => found is T = ...

    Type Declaration

      • <T extends unknown>(
            found: any,
            wanted: T,
            ...__namedParameters: MessageExtra,
        ): found is T
      • Verify that the value is strictly equivalent to the supplied pattern

        Type Parameters

        • T extends unknown

        Parameters

        Returns found is T

    similar: (
        found: any,
        wanted: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, wanted: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value matches the pattern provided

        Parameters

        Returns boolean

    strict_deep_equal: <T extends unknown>(
        found: any,
        wanted: T,
        ...__namedParameters: MessageExtra,
    ) => found is T = ...

    Type Declaration

      • <T extends unknown>(
            found: any,
            wanted: T,
            ...__namedParameters: MessageExtra,
        ): found is T
      • Verify that the value is strictly equivalent to the supplied pattern

        Type Parameters

        • T extends unknown

        Parameters

        Returns found is T

    strict_deep_equals: <T extends unknown>(
        found: any,
        wanted: T,
        ...__namedParameters: MessageExtra,
    ) => found is T = ...

    Type Declaration

      • <T extends unknown>(
            found: any,
            wanted: T,
            ...__namedParameters: MessageExtra,
        ): found is T
      • Verify that the value is strictly equivalent to the supplied pattern

        Type Parameters

        • T extends unknown

        Parameters

        Returns found is T

    strict_deep_inequal: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value is not strictly equivalent to the supplied pattern object

        Parameters

        Returns boolean

    strict_deep_inequals: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value is not strictly equivalent to the supplied pattern object

        Parameters

        Returns boolean

    strict_equal: <T extends unknown>(
        found: any,
        wanted: T,
        ...__namedParameters: MessageExtra,
    ) => found is T = ...

    Type Declaration

      • <T extends unknown>(
            found: any,
            wanted: T,
            ...__namedParameters: MessageExtra,
        ): found is T
      • Verify that the values are equal

        Type Parameters

        • T extends unknown

        Parameters

        Returns found is T

    strict_equals: <T extends unknown>(
        found: any,
        wanted: T,
        ...__namedParameters: MessageExtra,
    ) => found is T = ...

    Type Declaration

      • <T extends unknown>(
            found: any,
            wanted: T,
            ...__namedParameters: MessageExtra,
        ): found is T
      • Verify that the values are equal

        Type Parameters

        • T extends unknown

        Parameters

        Returns found is T

    strict_equivalent: <T extends unknown>(
        found: any,
        wanted: T,
        ...__namedParameters: MessageExtra,
    ) => found is T = ...

    Type Declaration

      • <T extends unknown>(
            found: any,
            wanted: T,
            ...__namedParameters: MessageExtra,
        ): found is T
      • Verify that the value is strictly equivalent to the supplied pattern

        Type Parameters

        • T extends unknown

        Parameters

        Returns found is T

    strict_inequivalent: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value is not strictly equivalent to the supplied pattern object

        Parameters

        Returns boolean

    strict_is: <T extends unknown>(
        found: any,
        wanted: T,
        ...__namedParameters: MessageExtra,
    ) => found is T = ...

    Type Declaration

      • <T extends unknown>(
            found: any,
            wanted: T,
            ...__namedParameters: MessageExtra,
        ): found is T
      • Verify that the values are equal

        Type Parameters

        • T extends unknown

        Parameters

        Returns found is T

    strict_not_same: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value is not strictly equivalent to the supplied pattern object

        Parameters

        Returns boolean

    strict_same: <T extends unknown>(
        found: any,
        wanted: T,
        ...__namedParameters: MessageExtra,
    ) => found is T = ...

    Type Declaration

      • <T extends unknown>(
            found: any,
            wanted: T,
            ...__namedParameters: MessageExtra,
        ): found is T
      • Verify that the value is strictly equivalent to the supplied pattern

        Type Parameters

        • T extends unknown

        Parameters

        Returns found is T

    strictdeepequal: <T extends unknown>(
        found: any,
        wanted: T,
        ...__namedParameters: MessageExtra,
    ) => found is T = ...

    Type Declaration

      • <T extends unknown>(
            found: any,
            wanted: T,
            ...__namedParameters: MessageExtra,
        ): found is T
      • Verify that the value is strictly equivalent to the supplied pattern

        Type Parameters

        • T extends unknown

        Parameters

        Returns found is T

    strictDeepEqual: <T extends unknown>(
        found: any,
        wanted: T,
        ...__namedParameters: MessageExtra,
    ) => found is T = ...

    Type Declaration

      • <T extends unknown>(
            found: any,
            wanted: T,
            ...__namedParameters: MessageExtra,
        ): found is T
      • Verify that the value is strictly equivalent to the supplied pattern

        Type Parameters

        • T extends unknown

        Parameters

        Returns found is T

    strictdeepequals: <T extends unknown>(
        found: any,
        wanted: T,
        ...__namedParameters: MessageExtra,
    ) => found is T = ...

    Type Declaration

      • <T extends unknown>(
            found: any,
            wanted: T,
            ...__namedParameters: MessageExtra,
        ): found is T
      • Verify that the value is strictly equivalent to the supplied pattern

        Type Parameters

        • T extends unknown

        Parameters

        Returns found is T

    strictDeepEquals: <T extends unknown>(
        found: any,
        wanted: T,
        ...__namedParameters: MessageExtra,
    ) => found is T = ...

    Type Declaration

      • <T extends unknown>(
            found: any,
            wanted: T,
            ...__namedParameters: MessageExtra,
        ): found is T
      • Verify that the value is strictly equivalent to the supplied pattern

        Type Parameters

        • T extends unknown

        Parameters

        Returns found is T

    strictdeepinequal: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value is not strictly equivalent to the supplied pattern object

        Parameters

        Returns boolean

    strictDeepInequal: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value is not strictly equivalent to the supplied pattern object

        Parameters

        Returns boolean

    strictdeepinequals: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value is not strictly equivalent to the supplied pattern object

        Parameters

        Returns boolean

    strictDeepInequals: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value is not strictly equivalent to the supplied pattern object

        Parameters

        Returns boolean

    strictequal: <T extends unknown>(
        found: any,
        wanted: T,
        ...__namedParameters: MessageExtra,
    ) => found is T = ...

    Type Declaration

      • <T extends unknown>(
            found: any,
            wanted: T,
            ...__namedParameters: MessageExtra,
        ): found is T
      • Verify that the values are equal

        Type Parameters

        • T extends unknown

        Parameters

        Returns found is T

    strictEqual: <T extends unknown>(
        found: any,
        wanted: T,
        ...__namedParameters: MessageExtra,
    ) => found is T = ...

    Type Declaration

      • <T extends unknown>(
            found: any,
            wanted: T,
            ...__namedParameters: MessageExtra,
        ): found is T
      • Verify that the values are equal

        Type Parameters

        • T extends unknown

        Parameters

        Returns found is T

    strictequals: <T extends unknown>(
        found: any,
        wanted: T,
        ...__namedParameters: MessageExtra,
    ) => found is T = ...

    Type Declaration

      • <T extends unknown>(
            found: any,
            wanted: T,
            ...__namedParameters: MessageExtra,
        ): found is T
      • Verify that the values are equal

        Type Parameters

        • T extends unknown

        Parameters

        Returns found is T

    strictEquals: <T extends unknown>(
        found: any,
        wanted: T,
        ...__namedParameters: MessageExtra,
    ) => found is T = ...

    Type Declaration

      • <T extends unknown>(
            found: any,
            wanted: T,
            ...__namedParameters: MessageExtra,
        ): found is T
      • Verify that the values are equal

        Type Parameters

        • T extends unknown

        Parameters

        Returns found is T

    strictequivalent: <T extends unknown>(
        found: any,
        wanted: T,
        ...__namedParameters: MessageExtra,
    ) => found is T = ...

    Type Declaration

      • <T extends unknown>(
            found: any,
            wanted: T,
            ...__namedParameters: MessageExtra,
        ): found is T
      • Verify that the value is strictly equivalent to the supplied pattern

        Type Parameters

        • T extends unknown

        Parameters

        Returns found is T

    strictEquivalent: <T extends unknown>(
        found: any,
        wanted: T,
        ...__namedParameters: MessageExtra,
    ) => found is T = ...

    Type Declaration

      • <T extends unknown>(
            found: any,
            wanted: T,
            ...__namedParameters: MessageExtra,
        ): found is T
      • Verify that the value is strictly equivalent to the supplied pattern

        Type Parameters

        • T extends unknown

        Parameters

        Returns found is T

    strictinequivalent: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value is not strictly equivalent to the supplied pattern object

        Parameters

        Returns boolean

    strictInequivalent: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value is not strictly equivalent to the supplied pattern object

        Parameters

        Returns boolean

    strictis: <T extends unknown>(
        found: any,
        wanted: T,
        ...__namedParameters: MessageExtra,
    ) => found is T = ...

    Type Declaration

      • <T extends unknown>(
            found: any,
            wanted: T,
            ...__namedParameters: MessageExtra,
        ): found is T
      • Verify that the values are equal

        Type Parameters

        • T extends unknown

        Parameters

        Returns found is T

    strictIs: <T extends unknown>(
        found: any,
        wanted: T,
        ...__namedParameters: MessageExtra,
    ) => found is T = ...

    Type Declaration

      • <T extends unknown>(
            found: any,
            wanted: T,
            ...__namedParameters: MessageExtra,
        ): found is T
      • Verify that the values are equal

        Type Parameters

        • T extends unknown

        Parameters

        Returns found is T

    strictnotsame: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value is not strictly equivalent to the supplied pattern object

        Parameters

        Returns boolean

    strictsame: <T extends unknown>(
        found: any,
        wanted: T,
        ...__namedParameters: MessageExtra,
    ) => found is T = ...

    Type Declaration

      • <T extends unknown>(
            found: any,
            wanted: T,
            ...__namedParameters: MessageExtra,
        ): found is T
      • Verify that the value is strictly equivalent to the supplied pattern

        Type Parameters

        • T extends unknown

        Parameters

        Returns found is T

    throw: (
        fn: Function | (() => any),
        ...__namedParameters: ThrowsArgs,
    ) => boolean | Error = ...

    Type Declaration

      • (fn: Function | (() => any), ...__namedParameters: ThrowsArgs): boolean | Error
      • Verify that the function throws an error. Thrown error is tested against the wanted param if provided, using t.match().

        Returns false on failure, or the error object thrown on success

        Parameters

        • fn: Function | (() => any)
        • ...__namedParameters: ThrowsArgs

        Returns boolean | Error

    true: (obj: any, ...__namedParameters: MessageExtra) => boolean = ...

    Type Declaration

      • (obj: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value is truthy

        Parameters

        Returns boolean

    unlike: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value does NOT match the pattern provided.

        Parameters

        Returns boolean

    unsimilar: (
        found: any,
        doNotWant: any,
        ...__namedParameters: MessageExtra,
    ) => boolean = ...

    Type Declaration

      • (found: any, doNotWant: any, ...__namedParameters: MessageExtra): boolean
      • Verify that the value does NOT match the pattern provided.

        Parameters

        Returns boolean

    Test Lifecycle Management

    done: (implicit?: typeof IMPLICIT) => this = ...

    Type Declaration

      • (implicit?: typeof IMPLICIT): this
      • Explicitly mark the test as completed, outputting the TAP plan line if needed.

        This is not required to be called if the test function returns a promise, or if a plan is explicitly declared and eventually fulfilled.

        Parameters

        Returns this