Skip to content

[@types/node] #68439 Test mock implementations should use the typed function F #68440

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

Closed
gorankarlic wants to merge 7 commits into from
Closed

[@types/node] #68439 Test mock implementations should use the typed function F #68440

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
ed7469d
#68439 Test mock implementations should use the typed function F
gorankarlic Feb 2, 2024
53e5abf
Improve documentation to reflect Node.js docs.
gorankarlic Feb 5, 2024
5f6d04a
Improve documentation to reflect Node.js docs.
gorankarlic Feb 5, 2024
b503a7d
Test mock method, getter and setter should also be typed.
gorankarlic Feb 5, 2024
99edc2b
Return correct mock type.
gorankarlic Feb 5, 2024
1d52c95
Unified typing for method, getter and setter.
gorankarlic Feb 5, 2024
97c2012
Redo type safe getter, setter and method due to test regression.
gorankarlic Feb 5, 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
37 changes: 22 additions & 15 deletions types/node/test.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -790,25 +790,32 @@ declare module "node:test" {
method<
MockedObject extends object,
MethodName extends FunctionPropertyNames<MockedObject>,
Implementation extends Function,
Implementation extends MockedObject[MethodName] extends Function ? MockedObject[MethodName] : never,
>(
object: MockedObject,
methodName: MethodName,
implementation: Implementation,
options?: MockFunctionOptions,
): MockedObject[MethodName] extends Function ? Mock<MockedObject[MethodName] | Implementation>
: never;
method<MockedObject extends object>(
): Mock<Implementation>;
method<
MockedObject extends object,
MethodName extends keyof MockedObject,
Implementation extends MockedObject[MethodName] extends Function ? MockedObject[MethodName] : Function,
>(
object: MockedObject,
methodName: keyof MockedObject,
methodName: MethodName,
options: MockMethodOptions,
): Mock<Function>;
method<MockedObject extends object>(
): Mock<Implementation>;
method<
MockedObject extends object,
MethodName extends keyof MockedObject,
Implementation extends MockedObject[MethodName] extends Function ? MockedObject[MethodName] : Function,
>(
object: MockedObject,
methodName: keyof MockedObject,
implementation: Function,
options: MockMethodOptions,
): Mock<Function>;
): Mock<Implementation>;

/**
* This function is syntax sugar for `MockTracker.method` with `options.getter`set to `true`.
Expand All @@ -825,13 +832,13 @@ declare module "node:test" {
getter<
MockedObject extends object,
MethodName extends keyof MockedObject,
Implementation extends Function,
Implementation extends () => MockedObject[MethodName],
>(
object: MockedObject,
methodName: MethodName,
implementation?: Implementation,
options?: MockFunctionOptions,
): Mock<(() => MockedObject[MethodName]) | Implementation>;
): Mock<Implementation>;
/**
* This function is syntax sugar for `MockTracker.method` with `options.setter`set to `true`.
* @since v19.3.0, v18.13.0
Expand All @@ -847,13 +854,13 @@ declare module "node:test" {
setter<
MockedObject extends object,
MethodName extends keyof MockedObject,
Implementation extends Function,
Implementation extends (value: MockedObject[MethodName]) => void,
>(
object: MockedObject,
methodName: MethodName,
implementation?: Implementation,
options?: MockFunctionOptions,
): Mock<((value: MockedObject[MethodName]) => void) | Implementation>;
): Mock<Implementation>;
/**
* This function restores the default behavior of all mocks that were previously
* created by this `MockTracker` and disassociates the mocks from the`MockTracker` instance. Once disassociated, the mocks can still be used, but the`MockTracker` instance can no longer be
Expand Down Expand Up @@ -962,7 +969,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 @@ -997,9 +1004,9 @@ declare module "node:test" {
* ```
* @since v19.1.0, v18.13.0
* @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.
* @param [onCall=The number of the next invocation.] 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