mirror of
https://github.com/zhigang1992/DefinitelyTyped.git
synced 2026-06-01 19:45:48 +08:00
de209e9896
Add a short and simple `index.d.ts` file for npm package mocha-each, with use-example tests in file `mocha-each-tests.ts`. Typings provided in this commit are not very tight: see file `index.d.ts` for further detail.
51 lines
2.0 KiB
TypeScript
51 lines
2.0 KiB
TypeScript
// Type definitions for mocha-each 1.1
|
|
// Project: https://github.com/ryym/mocha-each#readme
|
|
// Definitions by: Tom Harley <https://github.com/magnostherobot>
|
|
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
|
// TypeScript Version: 2.1
|
|
|
|
import { ITest, ITestDefinition, ITestCallbackContext } from 'mocha';
|
|
|
|
/**
|
|
* This function takes an array collections of parameters to be used in
|
|
* a series of mocha tests, defined using the `it` notation common to
|
|
* Mocha.
|
|
*/
|
|
declare function forEach(
|
|
parameters: ReadonlyArray<any>,
|
|
defaultIt?: ITestDefinition
|
|
): { it: ForEachITestDefinition };
|
|
|
|
/**
|
|
* This interface describes the kind of `it` available from a `forEach` call.
|
|
* The result is very similar to Mocha's `ITestDefinition` interface.
|
|
*/
|
|
interface ForEachITestDefinition {
|
|
/*
|
|
* The callback functions in each of these properties take a variable
|
|
* number of arguments, based on how many values were passed in tuples
|
|
* in the call of forEach that generated this property.
|
|
*
|
|
* This problem is similar to `Function.prototype.apply`, which also
|
|
* does not have strong typing
|
|
* (see github.com/Microsoft/Typescript/issues/212).
|
|
*
|
|
* These callback functions can all accept an optional callback generated
|
|
* by mocha, which is used for asynchronous code testing. However,
|
|
* since rest parameters have to be the final parameter in a function
|
|
* declaration, this function cannot be explicitly mentioned here.
|
|
*
|
|
* A more accurate signature for the callback functions would be
|
|
* callback?: (this, ...args, done?: MochaDone)
|
|
* Additionally, Mocha does not export its MochaDone interface.
|
|
*/
|
|
(expectation: string, callback?:
|
|
(this: ITestCallbackContext, ...args: any[]) => any): ITest;
|
|
only(expectation: string, callback?:
|
|
(this: ITestCallbackContext, ...args: any[]) => any): ITest;
|
|
skip(expectation: string, callback?:
|
|
(this: ITestCallbackContext, ...args: any[]) => any): ITest;
|
|
}
|
|
|
|
export = forEach;
|