Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: improve types #42

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
+176 −52
Open

fix: improve types #42

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
77308d5
fix: improve types
hongaar Dec 15, 2022
29c3de0
chore: format with prettier
hongaar Dec 16, 2022
54dc7d8
fix: make all exported fn params optional
hongaar Dec 16, 2022
9225f9e
fix: make 2nd+ params optional in overloads
hongaar Dec 16, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
fix: make all exported fn params optional
@hongaar
hongaar committed Dec 16, 2022
commit 54dc7d87a87756b99f9b9f8d642f723410d385f5
32 changes: 18 additions & 14 deletions lib/test.d.ts
View file
Original file line number Diff line number Diff line change
@@ -61,13 +61,13 @@ export default test;
* @returns A {@link Promise} resolved with `undefined` once the test completes.
*/
export function test(
name: string,
options: TestOptions,
fn: TestFn
name?: string,
options?: TestOptions,
fn?: TestFn
): Promise<void>;
export function test(name: string, fn: TestFn): Promise<void>;
export function test(options: TestOptions, fn: TestFn): Promise<void>;
export function test(fn: TestFn): Promise<void>;
export function test(name?: string, fn?: TestFn): Promise<void>;
export function test(options?: TestOptions, fn?: TestFn): Promise<void>;
export function test(fn?: TestFn): Promise<void>;

type SuiteFn = (t: SuiteContext) => void;

@@ -82,10 +82,14 @@ type SuiteFn = (t: SuiteContext) => void;
* function.
* @returns `undefined`
*/
export function describe(name: string, options: TestOptions, fn: SuiteFn): void;
export function describe(name: string, fn: SuiteFn): void;
export function describe(options: TestOptions, fn: SuiteFn): void;
export function describe(fn: SuiteFn): void;
export function describe(
name?: string,
options?: TestOptions,
fn?: SuiteFn
): void;
export function describe(name?: string, fn?: SuiteFn): void;
export function describe(options?: TestOptions, fn?: SuiteFn): void;
export function describe(fn?: SuiteFn): void;

type ItFn = (done: (result?: any) => void) => any;

@@ -99,10 +103,10 @@ type ItFn = (done: (result?: any) => void) => any;
* function is passed as an argument. Default: A no-op function.
* @returns `undefined`
*/
export function it(name: string, options: TestOptions, fn: ItFn): void;
export function it(name: string, fn: ItFn): void;
export function it(options: TestOptions, fn: ItFn): void;
export function it(fn: ItFn): void;
export function it(name?: string, options?: TestOptions, fn?: ItFn): void;
export function it(name?: string, fn?: ItFn): void;
export function it(options?: TestOptions, fn?: ItFn): void;
export function it(fn?: ItFn): void;

type HookFn = (done: (result?: any) => void) => any;