/// <reference types="node" />

import tapeSync = require("tape");
export = tape;

declare function tape(name: string | tape.TestOptions, cb: tape.TestCase): void;
declare function tape(name: string, opts: tape.TestOptions, cb: tape.TestCase): void;
declare function tape(cb: tape.TestCase): void;

declare namespace tape {
    interface TestCase {
        // eslint-disable-next-line @typescript-eslint/no-invalid-void-type
        (test: Test): void | Iterator<any> | PromiseLike<void>;
    }

    /**
     * Available opts options for the tape function.
     */
    type TestOptions = tapeSync.TestOptions;

    /**
     * Options for the createStream function.
     */
    type StreamOptions = tapeSync.StreamOptions;

    /**
     * Generate a new test that will be skipped over.
     */
    function skip(name: string | TestOptions, cb: TestCase): void;
    function skip(name: string, opts: TestOptions, cb: TestCase): void;
    function skip(cb: TestCase): void;

    /**
     * The onFinish hook will get invoked when ALL tape tests have finished right before tape is about to print the test summary.
     */
    function onFinish(cb: () => void): void;

    /**
     * Like test(name?, opts?, cb) except if you use .only this is the only test case that will run for the entire process, all other test cases using tape will be ignored.
     */
    function only(name: string | TestOptions, cb: TestCase): void;
    function only(name: string, opts: TestOptions, cb: TestCase): void;
    function only(cb: TestCase): void;

    /**
     * Create a new test harness instance, which is a function like test(), but with a new pending stack and test state.
     */
    function createHarness(): typeof tape;
    /**
     * Create a stream of output, bypassing the default output stream that writes messages to console.log().
     * By default stream will be a text stream of TAP output, but you can get an object stream instead by setting opts.objectMode to true.
     */
    function createStream(opts?: StreamOptions): NodeJS.ReadableStream;

    interface Test extends tapeSync.Test {
        /**
         * Create a subtest with a new test handle st from cb(st) inside the current test.
         * cb(st) will only fire when t finishes.
         * Additional tests queued up after t will not be run until all subtests finish.
         */
        test(name: string, cb: TestCase): void;
        test(name: string, opts: TestOptions, cb: TestCase): void;
    }
}