Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
124 changes: 98 additions & 26 deletions .vscode/launch.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

45 changes: 45 additions & 0 deletions packages/bun-types/test.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -186,6 +186,12 @@ declare module "bun:test" {
* @param fn the function that defines the tests
*/
todo(label: string, fn?: () => void): void;
/**
* Marks this group of tests as broken and in need of fixing.
* @param label the label for the tests
* @param fn the function that defines the tests
*/
fixme(label: string, fn?: () => void): void;
/**
* Runs this group of tests, only if `condition` is true.
*
Expand Down Expand Up @@ -387,6 +393,21 @@ declare module "bun:test" {
fn?: (() => void | Promise<unknown>) | ((done: (err?: unknown) => void) => void),
options?: number | TestOptions,
): void;
/**
* Marks this test as broken and in need of fixing.
*
* If the test function fails, it will be marked as `fixme` in the test results
* instead of `fail`. This is useful for marking tests that are known to be broken.
*
* @param label the label for the test
* @param fn the test function
* @param options the test timeout or options
*/
fixme(
label: string,
fn?: (() => void | Promise<unknown>) | ((done: (err?: unknown) => void) => void),
options?: number | TestOptions,
): void;
/**
* Runs this test, if `condition` is true.
*
Expand All @@ -413,6 +434,30 @@ declare module "bun:test" {
fn: (() => void | Promise<unknown>) | ((done: (err?: unknown) => void) => void),
options?: number | TestOptions,
) => void;
/**
* Marks this test as `todo`, if `condition` is true.
*
* @param condition if the test should be marked as `todo`
*/
todoIf(
condition: boolean,
): (
label: string,
fn?: (() => void | Promise<unknown>) | ((done: (err?: unknown) => void) => void),
options?: number | TestOptions,
) => void;
/**
* Marks this test as `fixme`, if `condition` is true.
*
* @param condition if the test should be marked as `fixme`
*/
fixmeIf(
condition: boolean,
): (
label: string,
fn?: (() => void | Promise<unknown>) | ((done: (err?: unknown) => void) => void),
options?: number | TestOptions,
) => void;
/**
* Returns a function that runs for each item in `table`.
*
Expand Down
Loading