@types/mocha-each

Installation

npm install --save @types/mocha-each

Summary

This package contains type definitions for mocha-each (https://github.com/ryym/mocha-each#readme).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/mocha-each.

index.d.ts

import { Context, Suite, SuiteFunction, Test, TestFunction } from "mocha";

/**
 * This function takes an array collections of parameters to be used in
 * a series of mocha tests, defined using the `it` or `describe` notation common to
 * Mocha.
 */
declare function forEach(
    parameters: readonly any[],
    dIt?: TestFunction,
    dDescribe?: SuiteFunction,
): { it: ForEachTestFunction; describe: ForEachDescribeDefinition };

/**
 * This interface describes the kind of `it` available from a `forEach` call.
 * The result is very similar to Mocha's `TestFunction` interface.
 */
interface ForEachTestFunction {
    (expectation: string, callback?: (this: Context, ...args: any[]) => any): Test;
    only(expectation: string, callback?: (this: Context, ...args: any[]) => any): Test;
    skip(expectation: string, callback?: (this: Context, ...args: any[]) => any): Test;
}

/**
 * This interface describes the kind of `describe` available from a `forEach` call.
 * The result is almost identical to Mocha's `SuiteFunction` interface.
 */
interface ForEachDescribeDefinition {
    (expectation: string, callback?: (this: Context, ...args: any[]) => any): Suite;
    only(expectation: string, callback?: (this: Context, ...args: any[]) => any): Suite;
    skip(expectation: string, callback?: (this: Context, ...args: any[]) => any): Suite;
}

export = forEach;

Additional Details

• Last updated: Mon, 20 Nov 2023 2324 GMT
• Dependencies: @types/mocha

Credits

These definitions were written by Tom Harley, and Noah May.