Skip to content

feat(node): Add mock module #69895

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
Jul 5, 2024
Merged

feat(node): Add mock module #69895

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
7ebca87
feat(node): Add mock module
rozzilla Jun 24, 2024
36502e5
Add test
rozzilla Jun 24, 2024
e9a15cb
Format
rozzilla Jun 24, 2024
5e8259c
Add defaultExport
rozzilla Jun 24, 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
11 changes: 11 additions & 0 deletions types/node/test.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -941,6 +941,17 @@ declare module "node:test" {
* @since v19.1.0, v18.13.0
*/
restoreAll(): void;
/**
* This function is used to mock the exports of ECMAScript modules,
* CommonJS modules, and Node.js builtin modules. Any references to
* the original module prior to mocking are not impacted
* @since v22.3.0
*/
module(speficier: string, options?: {
cache?: boolean;
defaultExport?: any;
namedExports?: object;
}): { restore: () => void };
timers: MockTimers;
}
const mock: MockTracker;
Expand Down
16 changes: 16 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 @@ -391,6 +391,22 @@ test("mocks a counting function", (t) => {
const fn = t.mock.fn(addOne, addTwo, { times: 2 });
// $ExpectType number
fn();

const mock = t.mock.module("node:readline", {
namedExports: {
fn() {
return 42;
},
},
defaultExport: {
foo() {
return "bar";
},
},
cache: true,
});
// $ExpectType void
mock.restore();
});

test("spies on an object method", (t) => {
Expand Down