@exodus/test
    Preparing search index...

    Interface Test

    Tape test context/assertion object

    interface Test {
        assert(value: any, msg?: string): void;
        assertion(fn: Function, ...args: any[]): void;
        comment(msg: string): void;
        deepEqual(actual: any, expected: any, msg?: string): void;
        deepEquals(actual: any, expected: any, msg?: string): void;
        deepLooseEqual(actual: any, expected: any, msg?: string): void;
        doesNotEqual(actual: any, expected: any, msg?: string): void;
        doesNotReject(
            promise: Promise<any>,
            expected?: Function | RegExp,
            msg?: string,
        ): Promise<void>;
        doesNotThrow(
            fn: () => any,
            expected?: Function | RegExp,
            msg?: string,
        ): void;
        end(): void;
        equal(actual: any, expected: any, msg?: string): void;
        equals(actual: any, expected: any, msg?: string): void;
        error(err: any, msg?: string): void;
        fail(msg?: string): void;
        false(value: any, msg?: string): void;
        ifErr(err: any, msg?: string): void;
        iferror(err: any, msg?: string): void;
        ifError(err: any, msg?: string): void;
        is(actual: any, expected: any, msg?: string): void;
        isEqual(actual: any, expected: any, msg?: string): void;
        isEquivalent(actual: any, expected: any, msg?: string): void;
        isInequal(actual: any, expected: any, msg?: string): void;
        isInequivalent(actual: any, expected: any, msg?: string): void;
        isNot(actual: any, expected: any, msg?: string): void;
        isNotDeepEqual(actual: any, expected: any, msg?: string): void;
        isNotDeeply(actual: any, expected: any, msg?: string): void;
        isNotEqual(actual: any, expected: any, msg?: string): void;
        isNotEquivalent(actual: any, expected: any, msg?: string): void;
        looseEqual(actual: any, expected: any, msg?: string): void;
        looseEquals(actual: any, expected: any, msg?: string): void;
        not(actual: any, expected: any, msg?: string): void;
        notDeepEqual(actual: any, expected: any, msg?: string): void;
        notDeepEquals(actual: any, expected: any, msg?: string): void;
        notDeepLooseEqual(actual: any, expected: any, msg?: string): void;
        notDeeply(actual: any, expected: any, msg?: string): void;
        notEqual(actual: any, expected: any, msg?: string): void;
        notEquals(actual: any, expected: any, msg?: string): void;
        notEquivalent(actual: any, expected: any, msg?: string): void;
        notLooseEqual(actual: any, expected: any, msg?: string): void;
        notLooseEquals(actual: any, expected: any, msg?: string): void;
        notok(value: any, msg?: string): void;
        notOk(value: any, msg?: string): void;
        notSame(actual: any, expected: any, msg?: string): void;
        notStrictEqual(actual: any, expected: any, msg?: string): void;
        notStrictEquals(actual: any, expected: any, msg?: string): void;
        ok(value: any, msg?: string): void;
        pass(msg?: string): void;
        plan(count: number): void;
        rejects(
            promise: Promise<any>,
            expected?: Function | RegExp,
            msg?: string,
        ): Promise<void>;
        resolves(promise: Promise<any>, msg?: string): Promise<void>;
        same(actual: any, expected: any, msg?: string): void;
        skip(msg?: string): void;
        strictEqual(actual: any, expected: any, msg?: string): void;
        strictEquals(actual: any, expected: any, msg?: string): void;
        test(name: string, cb: (t: Test) => void): void;
        test(name: string, opts: TestOptions, cb: (t: Test) => void): void;
        throws(fn: () => any, expected?: Function | RegExp, msg?: string): void;
        todo(msg?: string): void;
        true(value: any, msg?: string): void;
    }
    Index

    Methods

    • Parameters

      • value: any
      • Optionalmsg: string

      Returns void

    • Custom assertion function

      Parameters

      • fn: Function
      • ...args: any[]

      Returns void

    • Adds a comment

      Parameters

      • msg: string

      Returns void

    • Assert deep strict equality

      Parameters

      • actual: any
      • expected: any
      • Optionalmsg: string

      Returns void

    • Parameters

      • actual: any
      • expected: any
      • Optionalmsg: string

      Returns void

    • Assert deep loose equality

      Parameters

      • actual: any
      • expected: any
      • Optionalmsg: string

      Returns void

    • Parameters

      • actual: any
      • expected: any
      • Optionalmsg: string

      Returns void

    • Parameters

      • promise: Promise<any>
      • Optionalexpected: Function | RegExp
      • Optionalmsg: string

      Returns Promise<void>

    • Assert function does not throw

      Parameters

      • fn: () => any
      • Optionalexpected: Function | RegExp
      • Optionalmsg: string

      Returns void

    • Assert strict equality

      Parameters

      • actual: any
      • expected: any
      • Optionalmsg: string

      Returns void

    • Parameters

      • actual: any
      • expected: any
      • Optionalmsg: string

      Returns void

    • Assert no error

      Parameters

      • err: any
      • Optionalmsg: string

      Returns void

    • Force a failing assertion

      Parameters

      • Optionalmsg: string

      Returns void

    • Parameters

      • value: any
      • Optionalmsg: string

      Returns void

    • Parameters

      • err: any
      • Optionalmsg: string

      Returns void

    • Parameters

      • err: any
      • Optionalmsg: string

      Returns void

    • Parameters

      • err: any
      • Optionalmsg: string

      Returns void

    • Parameters

      • actual: any
      • expected: any
      • Optionalmsg: string

      Returns void

    • Parameters

      • actual: any
      • expected: any
      • Optionalmsg: string

      Returns void

    • Parameters

      • actual: any
      • expected: any
      • Optionalmsg: string

      Returns void

    • Parameters

      • actual: any
      • expected: any
      • Optionalmsg: string

      Returns void

    • Parameters

      • actual: any
      • expected: any
      • Optionalmsg: string

      Returns void

    • Parameters

      • actual: any
      • expected: any
      • Optionalmsg: string

      Returns void

    • Parameters

      • actual: any
      • expected: any
      • Optionalmsg: string

      Returns void

    • Parameters

      • actual: any
      • expected: any
      • Optionalmsg: string

      Returns void

    • Parameters

      • actual: any
      • expected: any
      • Optionalmsg: string

      Returns void

    • Parameters

      • actual: any
      • expected: any
      • Optionalmsg: string

      Returns void

    • Assert loose equality

      Parameters

      • actual: any
      • expected: any
      • Optionalmsg: string

      Returns void

    • Parameters

      • actual: any
      • expected: any
      • Optionalmsg: string

      Returns void

    • Parameters

      • actual: any
      • expected: any
      • Optionalmsg: string

      Returns void

    • Assert deep strict inequality

      Parameters

      • actual: any
      • expected: any
      • Optionalmsg: string

      Returns void

    • Parameters

      • actual: any
      • expected: any
      • Optionalmsg: string

      Returns void

    • Assert deep loose inequality

      Parameters

      • actual: any
      • expected: any
      • Optionalmsg: string

      Returns void

    • Parameters

      • actual: any
      • expected: any
      • Optionalmsg: string

      Returns void

    • Assert strict inequality

      Parameters

      • actual: any
      • expected: any
      • Optionalmsg: string

      Returns void

    • Parameters

      • actual: any
      • expected: any
      • Optionalmsg: string

      Returns void

    • Parameters

      • actual: any
      • expected: any
      • Optionalmsg: string

      Returns void

    • Assert loose inequality

      Parameters

      • actual: any
      • expected: any
      • Optionalmsg: string

      Returns void

    • Parameters

      • actual: any
      • expected: any
      • Optionalmsg: string

      Returns void

    • Parameters

      • value: any
      • Optionalmsg: string

      Returns void

    • Assert that value is falsy

      Parameters

      • value: any
      • Optionalmsg: string

      Returns void

    • Parameters

      • actual: any
      • expected: any
      • Optionalmsg: string

      Returns void

    • Parameters

      • actual: any
      • expected: any
      • Optionalmsg: string

      Returns void

    • Parameters

      • actual: any
      • expected: any
      • Optionalmsg: string

      Returns void

    • Assert that value is truthy

      Parameters

      • value: any
      • Optionalmsg: string

      Returns void

    • Force a passing assertion

      Parameters

      • Optionalmsg: string

      Returns void

    • Plans the number of assertions

      Parameters

      • count: number

      Returns void

    • Assert promise rejects

      Parameters

      • promise: Promise<any>
      • Optionalexpected: Function | RegExp
      • Optionalmsg: string

      Returns Promise<void>

    • Assert promise resolves

      Parameters

      • promise: Promise<any>
      • Optionalmsg: string

      Returns Promise<void>

    • Parameters

      • actual: any
      • expected: any
      • Optionalmsg: string

      Returns void

    • Skips the test

      Parameters

      • Optionalmsg: string

      Returns void

    • Parameters

      • actual: any
      • expected: any
      • Optionalmsg: string

      Returns void

    • Parameters

      • actual: any
      • expected: any
      • Optionalmsg: string

      Returns void

    • Assert function throws

      Parameters

      • fn: () => any
      • Optionalexpected: Function | RegExp
      • Optionalmsg: string

      Returns void

    • Marks test as todo

      Parameters

      • Optionalmsg: string

      Returns void

    • Parameters

      • value: any
      • Optionalmsg: string

      Returns void