vhad/DefinitelyTyped
1
0
Fork 0
mirror of https://github.com/gosticks/DefinitelyTyped.git synced 2026-08-11 12:30:18 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

fix(mocha‑sugar‑free): Correct Options type (#42532)

Browse Source
This commit is contained in:
ExE Boss
2020-02-21 12:12:43 -08:00
committed by GitHub
parent d0cae85700
commit 3dee137d82
1 changed files with 25 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files
types/mocha-sugar-free/index.d.ts
Vendored
+25 -8
View File
@@ -9,17 +9,24 @@ import { Test, Suite } from 'mocha';
type Omit<T, K extends keyof any> = Pick<T, Exclude<keyof T, K>>;
declare namespace Mocha {
type TestCase = (this: undefined, context: TestContext) => void | PromiseLike<void>;
type TestCase = (this: undefined, context: TestContext) => void | PromiseLike<any>;
type TestCaseWithDone = (this: undefined, context: TestContextWithDone) => void;
type HookFunc = (this: undefined, context: HookContext) => void;
type SuiteFunc = (this: undefined, context: SuiteContext) => void;
interface Options {
[option: string]: any;
/**
* Whether the context should contain a `done` callback.
*/
async?: boolean;
/**
* Set whether timeouts are enabled.
*/
enableTimeouts?: boolean;
/**
* Whether failing to return a PromiseLike should fail the test.
*/
@@ -45,6 +52,16 @@ declare namespace Mocha {
*/
skipUnlessBrowser?: boolean;
/**
* Set test slowness threshold.
*/
slow?: string | number;
/**
* Set test timeout.
*/
timeout?: string | number;
/**
* The test title. Replaced by the title parameter if present.
*/
@@ -319,7 +336,7 @@ declare namespace Mocha {
/**
* Mark a test as completed.
*/
done(err: any): void;
done(err?: any): void;
}
// #endregion
@@ -404,10 +421,10 @@ declare namespace Mocha {
(fn: TestCase): Test;
(title: string, fn?: TestCase): Test;
(title: string, options: Options & { async?: false; fn?: TestCase }, fn?: TestCase): Test;
(title: string, options: Options & { async?: true; fn?: TestCase }, fn?: TestCaseWithDone): Test;
(title: string, options: Options & { async: true; fn?: TestCaseWithDone }, fn?: TestCaseWithDone): Test;
// tslint:disable-next-line: unified-signatures
(options: Options & { async?: false; fn?: TestCase }, fn?: TestCase): Test;
(options: Options & { async?: true; fn?: TestCase }, fn?: TestCaseWithDone): Test;
(options: Options & { async: true; fn?: TestCaseWithDone }, fn?: TestCaseWithDone): Test;
/**
* [bdd, tdd, qunit]
@@ -437,10 +454,10 @@ declare namespace Mocha {
(fn: TestCase): Test;
(title: string, fn?: TestCase): Test;
(title: string, options: Options & { async?: false; fn?: TestCase }, fn?: TestCase): Test;
(title: string, options: Options & { async?: true; fn?: TestCase }, fn?: TestCaseWithDone): Test;
(title: string, options: Options & { async: true; fn?: TestCaseWithDone }, fn?: TestCaseWithDone): Test;
// tslint:disable-next-line: unified-signatures
(options: Options & { async?: false; fn?: TestCase }, fn?: TestCase): Test;
(options: Options & { async?: true; fn?: TestCase }, fn?: TestCaseWithDone): Test;
(options: Options & { async: true; fn?: TestCaseWithDone }, fn?: TestCaseWithDone): Test;
}
/**
@@ -456,10 +473,10 @@ declare namespace Mocha {
(fn: TestCase): Test;
(title: string, fn?: TestCase): Test;
(title: string, options: Options & { async?: false; fn?: TestCase }, fn?: TestCase): Test;
(title: string, options: Options & { async?: true; fn?: TestCase }, fn?: TestCaseWithDone): Test;
(title: string, options: Options & { async: true; fn?: TestCaseWithDone }, fn?: TestCaseWithDone): Test;
// tslint:disable-next-line: unified-signatures
(options: Options & { async?: false; fn?: TestCase }, fn?: TestCase): Test;
(options: Options & { async?: true; fn?: TestCase }, fn?: TestCaseWithDone): Test;
(options: Options & { async: true; fn?: TestCaseWithDone }, fn?: TestCaseWithDone): Test;
}
// #endregion
}