Skip to content

feat(node): pass generic function implementation to mockImplementation and mockImplementationOnce for node:test #69856

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

Merged
typescript-bot merged 4 commits into from
Jun 22, 2024
Merged

feat(node): pass generic function implementation to mockImplementation and mockImplementationOnce for node:test #69856

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f53d355
feat(node): pass generic function implementation to `mockImplementati…
bacebu4 Jun 20, 2024
9bbd1d7
Revert "feat(node): pass generic function implementation to `mockImpl…
bacebu4 Jun 20, 2024
db5d526
feat: for testing
bacebu4 Jun 20, 2024
543e272
Merge branch 'DefinitelyTyped:master' into master
bacebu4 Jun 20, 2024
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
4 changes: 2 additions & 2 deletions types/node/test.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1031,7 +1031,7 @@ declare module "node:test" {
* @since v19.1.0, v18.13.0
* @param implementation The function to be used as the mock's new implementation.
*/
mockImplementation(implementation: Function): void;
mockImplementation(implementation: F): void;
/**
* This function is used to change the behavior of an existing mock for a single
* invocation. Once invocation `onCall` has occurred, the mock will revert to
Expand Down Expand Up @@ -1068,7 +1068,7 @@ declare module "node:test" {
* @param implementation The function to be used as the mock's implementation for the invocation number specified by `onCall`.
* @param onCall The invocation number that will use `implementation`. If the specified invocation has already occurred then an exception is thrown.
*/
mockImplementationOnce(implementation: Function, onCall?: number): void;
mockImplementationOnce(implementation: F, onCall?: number): void;
/**
* Resets the call history of the mock function.
* @since v19.3.0, v18.13.0
Expand Down
6 changes: 6 additions & 0 deletions types/node/test/test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -772,6 +772,12 @@ class TestReporter extends Transform {
}
}
const createdMock: Mock<() => undefined> = mock.fn(() => undefined);
// @ts-expect-error
createdMock.mock.mockImplementation(() => null);
createdMock.mock.mockImplementation(() => undefined);
// @ts-expect-error
createdMock.mock.mockImplementationOnce(() => null);
createdMock.mock.mockImplementationOnce(() => undefined);

// Allows for typing of TestContext outside of a test
const contextTest = (t: TestContext) => {
Expand Down
4 changes: 2 additions & 2 deletions types/node/v18/test.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -729,7 +729,7 @@ declare module "node:test" {
* This function is used to change the behavior of an existing mock.
* @param implementation The function to be used as the mock's new implementation.
*/
mockImplementation(implementation: Function): void;
mockImplementation(implementation: F): void;

/**
* This function is used to change the behavior of an existing mock for a single invocation.
Expand All @@ -739,7 +739,7 @@ declare module "node:test" {
* @param onCall The invocation number that will use `implementation`.
* If the specified invocation has already occurred then an exception is thrown.
*/
mockImplementationOnce(implementation: Function, onCall?: number): void;
mockImplementationOnce(implementation: F, onCall?: number): void;

/**
* Resets the call history of the mock function.
Expand Down