Hierarchy

  • Synonymized
    • Synonyms

Constructors

Assertion Methods

assert assertNot assert_not assertnot contains deepEqual deepEquals deepInequal deepIs deepNot deep_equal deep_equals deep_inequal deep_is deep_not deepequal deepequals deepinequal deepis deepnot dissimilar doesNotEqual doesNotHave does_not_equal does_not_have does_not_throw doesnotequal doesnothave doesnotthrow equals equivalent false hasFields has_fields hasfields identical ifErr ifError if_err if_error iferr iferror include includes inequal inequivalent is isA isDeep isDeeply isDissimilar isEqual isEquivalent isInequal isInequivalent isLike isLoose isNot isNotDeepEqual isNotDeeply isNotEqual isNotEquivalent isNotLike isNotSimilar isSimilar isStrict isStrictly isUnlike 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 isdeep isdeeply isdissimilar isequal isequivalent isinequal isinequivalent islike isloose isnot isnotdeepequal isnotdeeply isnotequal isnotequivalent isnotlike isnotsimilar issimilar isstrict isstrictly isunlike like looseEqual looseEquals looseInequal looseIs looseNot loose_equal loose_equals loose_inequal loose_is loose_not looseequal looseequals looseinequal looseis loosenot matches notDeep notDeepEqual notDeeply notEqual notEquals notEquivalent notLike notLoose notSameStrict notSimilar notStrictEqual notStrictEquals notStrictSame notThrow 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 notdeepequal notdeeply notequal notequals notequivalent notlike notloose notmatch notok notsame notsamestrict notsimilar notstrictequal notstrictequals notstrictsame notthrow sameStrict same_strict samestrict similar strictDeepEqual strictDeepEquals strictDeepInequal strictDeepInequals strictEqual strictEquals strictEquivalent strictInequivalent strictIs 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 strictdeepequals strictdeepinequal strictdeepinequals strictequal strictequals strictequivalent strictinequivalent strictis strictnotsame strictsame throw true unlike unsimilar

Test Lifecycle Management

Constructors

Assertion Methods

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

Type declaration

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

      Parameters

      Returns boolean

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

Type declaration

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

      Parameters

      Returns boolean

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

Type declaration

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

      Parameters

      Returns boolean

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

Type declaration

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

      Parameters

      Returns boolean

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

Type declaration

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

      Parameters

      Returns boolean

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

Type declaration

    • (found, wanted, ...__namedParameters): 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, wanted, ...__namedParameters): 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, doNotWant, ...__namedParameters): boolean
    • Verify that the value is not loosely equivalent to the supplied pattern

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

    • <T>(found, wanted, ...__namedParameters): 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, doNotWant, ...__namedParameters): boolean
    • Verify that the value is not strictly equivalent to the supplied pattern object

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

    • (found, wanted, ...__namedParameters): 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, wanted, ...__namedParameters): 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, doNotWant, ...__namedParameters): boolean
    • Verify that the value is not loosely equivalent to the supplied pattern

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

    • <T>(found, wanted, ...__namedParameters): 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, doNotWant, ...__namedParameters): boolean
    • Verify that the value is not strictly equivalent to the supplied pattern object

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

    • (found, wanted, ...__namedParameters): 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, wanted, ...__namedParameters): 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, doNotWant, ...__namedParameters): boolean
    • Verify that the value is not loosely equivalent to the supplied pattern

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

    • <T>(found, wanted, ...__namedParameters): 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, doNotWant, ...__namedParameters): boolean
    • Verify that the value is not strictly equivalent to the supplied pattern object

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

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

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

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

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

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

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

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

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

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

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

    • (fn, ...__namedParameters): 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)
      • Rest...__namedParameters: MessageExtra

      Returns boolean | Error

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

Type declaration

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

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

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

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

    • (fn, ...__namedParameters): 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)
      • Rest...__namedParameters: MessageExtra

      Returns boolean | Error

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

Type declaration

    • <T>(found, wanted, ...__namedParameters): 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, wanted, ...__namedParameters): boolean
    • Verify that the value is loosely equivalent to the supplied pattern

      Parameters

      Returns boolean

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

Type declaration

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

      Parameters

      Returns boolean

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

Type declaration

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

      Parameters

      Returns boolean

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

Type declaration

    • (found, wanted, ...__namedParameters): 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, wanted, ...__namedParameters): boolean
    • Verify that the object has all of the properties and values in the pattern, matching loosely.

      Parameters

      Returns boolean

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

Type declaration

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

      Type Parameters

      • T extends unknown

      Parameters

      Returns found is T

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

Type declaration

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

Type declaration

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

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

Type declaration

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

Type declaration

    • (found, wanted, ...__namedParameters): 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, wanted, ...__namedParameters): 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, doNotWant, ...__namedParameters): boolean
    • Verify that the values are not equal

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

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

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

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

      Type Parameters

      • T extends unknown

      Parameters

      Returns found is T

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

Type declaration

    • (obj, klass, ...__namedParameters): 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
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

    • <T>(found, wanted, ...__namedParameters): 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>(found: any, wanted: T, ...__namedParameters: MessageExtra) => found is T) = ...

Type declaration

    • <T>(found, wanted, ...__namedParameters): 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, doNotWant, ...__namedParameters): boolean
    • Verify that the value does NOT match the pattern provided.

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

    • <T>(found, wanted, ...__namedParameters): 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, wanted, ...__namedParameters): 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, doNotWant, ...__namedParameters): boolean
    • Verify that the values are not equal

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

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

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

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

      Parameters

      Returns boolean

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

Type declaration

    • (found, wanted, ...__namedParameters): 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, doNotWant, ...__namedParameters): boolean
    • Verify that the values are not equal

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

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

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

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

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

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

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

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

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

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

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

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

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

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

      Parameters

      Returns boolean

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

Type declaration

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

      Type Parameters

      • T extends unknown

      Parameters

      Returns found is T

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

Type declaration

    • <T>(found, wanted, ...__namedParameters): 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, doNotWant, ...__namedParameters): boolean
    • Verify that the value does NOT match the pattern provided.

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

    • (obj, klass, ...__namedParameters): 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
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

    • <T>(found, wanted, ...__namedParameters): 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>(found: any, wanted: T, ...__namedParameters: MessageExtra) => found is T) = ...

Type declaration

    • <T>(found, wanted, ...__namedParameters): 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, doNotWant, ...__namedParameters): boolean
    • Verify that the value does NOT match the pattern provided.

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

    • <T>(found, wanted, ...__namedParameters): 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, wanted, ...__namedParameters): 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, doNotWant, ...__namedParameters): boolean
    • Verify that the values are not equal

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

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

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

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

      Parameters

      Returns boolean

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

Type declaration

    • (found, wanted, ...__namedParameters): 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, doNotWant, ...__namedParameters): boolean
    • Verify that the values are not equal

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

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

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

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

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

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

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

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

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

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

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

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

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

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

      Parameters

      Returns boolean

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

Type declaration

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

      Type Parameters

      • T extends unknown

      Parameters

      Returns found is T

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

Type declaration

    • <T>(found, wanted, ...__namedParameters): 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, doNotWant, ...__namedParameters): boolean
    • Verify that the value does NOT match the pattern provided.

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

    • (obj, klass, ...__namedParameters): 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
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

    • <T>(found, wanted, ...__namedParameters): 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>(found: any, wanted: T, ...__namedParameters: MessageExtra) => found is T) = ...

Type declaration

    • <T>(found, wanted, ...__namedParameters): 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, doNotWant, ...__namedParameters): boolean
    • Verify that the value does NOT match the pattern provided.

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

    • <T>(found, wanted, ...__namedParameters): 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, wanted, ...__namedParameters): 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, doNotWant, ...__namedParameters): boolean
    • Verify that the values are not equal

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

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

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

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

      Parameters

      Returns boolean

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

Type declaration

    • (found, wanted, ...__namedParameters): 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, doNotWant, ...__namedParameters): boolean
    • Verify that the values are not equal

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

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

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

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

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

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

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

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

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

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

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

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

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

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

      Parameters

      Returns boolean

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

Type declaration

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

      Type Parameters

      • T extends unknown

      Parameters

      Returns found is T

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

Type declaration

    • <T>(found, wanted, ...__namedParameters): 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, doNotWant, ...__namedParameters): boolean
    • Verify that the value does NOT match the pattern provided.

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

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

      Parameters

      Returns boolean

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

Type declaration

    • (found, wanted, ...__namedParameters): 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, wanted, ...__namedParameters): 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, doNotWant, ...__namedParameters): boolean
    • Verify that the value is not loosely equivalent to the supplied pattern

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

    • (found, wanted, ...__namedParameters): 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, doNotWant, ...__namedParameters): boolean
    • Verify that the value is not loosely equivalent to the supplied pattern

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

    • (found, wanted, ...__namedParameters): 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, wanted, ...__namedParameters): 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, doNotWant, ...__namedParameters): boolean
    • Verify that the value is not loosely equivalent to the supplied pattern

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

    • (found, wanted, ...__namedParameters): 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, doNotWant, ...__namedParameters): boolean
    • Verify that the value is not loosely equivalent to the supplied pattern

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

    • (found, wanted, ...__namedParameters): 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, wanted, ...__namedParameters): 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, doNotWant, ...__namedParameters): boolean
    • Verify that the value is not loosely equivalent to the supplied pattern

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

    • (found, wanted, ...__namedParameters): 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, doNotWant, ...__namedParameters): boolean
    • Verify that the value is not loosely equivalent to the supplied pattern

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

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

      Parameters

      Returns boolean

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

Type declaration

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

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

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

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

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

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

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

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

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

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

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

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

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

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

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

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

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

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

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

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

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

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

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

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

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

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

    • (fn, ...__namedParameters): 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)
      • Rest...__namedParameters: MessageExtra

      Returns boolean | Error

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

Type declaration

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

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

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

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

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

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

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

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

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

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

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

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

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

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

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

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

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

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

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

      Parameters

      Returns boolean

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

Type declaration

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

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

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

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

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

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

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

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

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

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

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

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

    • (fn, ...__namedParameters): 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)
      • Rest...__namedParameters: MessageExtra

      Returns boolean | Error

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

Type declaration

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

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

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

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

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

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

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

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

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

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

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

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

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

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

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

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

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

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

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

      Parameters

      Returns boolean

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

Type declaration

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

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

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

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

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

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

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

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

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

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

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

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

    • (fn, ...__namedParameters): 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)
      • Rest...__namedParameters: MessageExtra

      Returns boolean | Error

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

Type declaration

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

      Type Parameters

      • T extends unknown

      Parameters

      Returns found is T

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

Type declaration

    • <T>(found, wanted, ...__namedParameters): 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>(found: any, wanted: T, ...__namedParameters: MessageExtra) => found is T) = ...

Type declaration

    • <T>(found, wanted, ...__namedParameters): 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, wanted, ...__namedParameters): boolean
    • Verify that the value matches the pattern provided

      Parameters

      Returns boolean

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

Type declaration

    • <T>(found, wanted, ...__namedParameters): 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>(found: any, wanted: T, ...__namedParameters: MessageExtra) => found is T) = ...

Type declaration

    • <T>(found, wanted, ...__namedParameters): 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, doNotWant, ...__namedParameters): boolean
    • Verify that the value is not strictly equivalent to the supplied pattern object

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

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

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

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

      Type Parameters

      • T extends unknown

      Parameters

      Returns found is T

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

Type declaration

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

      Type Parameters

      • T extends unknown

      Parameters

      Returns found is T

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

Type declaration

    • <T>(found, wanted, ...__namedParameters): 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, doNotWant, ...__namedParameters): boolean
    • Verify that the value is not strictly equivalent to the supplied pattern object

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

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

      Type Parameters

      • T extends unknown

      Parameters

      Returns found is T

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

Type declaration

    • <T>(found, wanted, ...__namedParameters): 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>(found: any, wanted: T, ...__namedParameters: MessageExtra) => found is T) = ...

Type declaration

    • <T>(found, wanted, ...__namedParameters): 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, doNotWant, ...__namedParameters): boolean
    • Verify that the value is not strictly equivalent to the supplied pattern object

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

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

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

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

      Type Parameters

      • T extends unknown

      Parameters

      Returns found is T

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

Type declaration

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

      Type Parameters

      • T extends unknown

      Parameters

      Returns found is T

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

Type declaration

    • <T>(found, wanted, ...__namedParameters): 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, doNotWant, ...__namedParameters): boolean
    • Verify that the value is not strictly equivalent to the supplied pattern object

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

    • <T>(found, wanted, ...__namedParameters): 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, doNotWant, ...__namedParameters): boolean
    • Verify that the value is not strictly equivalent to the supplied pattern object

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

    • <T>(found, wanted, ...__namedParameters): 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>(found: any, wanted: T, ...__namedParameters: MessageExtra) => found is T) = ...

Type declaration

    • <T>(found, wanted, ...__namedParameters): 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>(found: any, wanted: T, ...__namedParameters: MessageExtra) => found is T) = ...

Type declaration

    • <T>(found, wanted, ...__namedParameters): 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, doNotWant, ...__namedParameters): boolean
    • Verify that the value is not strictly equivalent to the supplied pattern object

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

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

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

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

      Type Parameters

      • T extends unknown

      Parameters

      Returns found is T

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

Type declaration

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

      Type Parameters

      • T extends unknown

      Parameters

      Returns found is T

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

Type declaration

    • <T>(found, wanted, ...__namedParameters): 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, doNotWant, ...__namedParameters): boolean
    • Verify that the value is not strictly equivalent to the supplied pattern object

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

    • <T>(found, wanted, ...__namedParameters): 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, doNotWant, ...__namedParameters): boolean
    • Verify that the value is not strictly equivalent to the supplied pattern object

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

    • <T>(found, wanted, ...__namedParameters): 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, ...__namedParameters): 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)
      • Rest...__namedParameters: ThrowsArgs

      Returns boolean | Error

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

Type declaration

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

      Parameters

      Returns boolean

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

Type declaration

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

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

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

Type declaration

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

      Parameters

      • found: any
      • doNotWant: any
      • Rest...__namedParameters: MessageExtra

      Returns boolean

Test Lifecycle Management

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

Type declaration

    • (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