From 955e0950581026e18390d818741534beeac52d04 Mon Sep 17 00:00:00 2001 From: Gareth Jones Date: Sat, 30 Jul 2022 11:22:14 +1200 Subject: [PATCH] docs: mock sugar fns are for API, not syntax --- docs/MockFunctionAPI.md | 10 +++++----- packages/jest-mock/README.md | 2 +- website/versioned_docs/version-25.x/MockFunctionAPI.md | 10 +++++----- website/versioned_docs/version-26.x/MockFunctionAPI.md | 10 +++++----- website/versioned_docs/version-27.x/MockFunctionAPI.md | 10 +++++----- website/versioned_docs/version-28.0/MockFunctionAPI.md | 10 +++++----- website/versioned_docs/version-28.1/MockFunctionAPI.md | 10 +++++----- 7 files changed, 31 insertions(+), 31 deletions(-) diff --git a/docs/MockFunctionAPI.md b/docs/MockFunctionAPI.md index db8f2d5ea4b3..be2ce406bccb 100644 --- a/docs/MockFunctionAPI.md +++ b/docs/MockFunctionAPI.md @@ -291,7 +291,7 @@ Expected mock function "mockedFunction" to have been called, but it was not call ### `mockFn.mockReturnThis()` -Syntactic sugar function for: +API sugar function for: ```js jest.fn(function () { @@ -355,7 +355,7 @@ mockFn(); // 'default' ### `mockFn.mockResolvedValue(value)` -Syntactic sugar function for: +API sugar function for: ```js jest.fn().mockImplementation(() => Promise.resolve(value)); @@ -381,7 +381,7 @@ test('async test', async () => { ### `mockFn.mockResolvedValueOnce(value)` -Syntactic sugar function for: +API sugar function for: ```js jest.fn().mockImplementationOnce(() => Promise.resolve(value)); @@ -421,7 +421,7 @@ test('async test', async () => { ### `mockFn.mockRejectedValue(value)` -Syntactic sugar function for: +API sugar function for: ```js jest.fn().mockImplementation(() => Promise.reject(value)); @@ -451,7 +451,7 @@ test('async test', async () => { ### `mockFn.mockRejectedValueOnce(value)` -Syntactic sugar function for: +API sugar function for: ```js jest.fn().mockImplementationOnce(() => Promise.reject(value)); diff --git a/packages/jest-mock/README.md b/packages/jest-mock/README.md index 5bc75093f8fa..72ae6d1b34f8 100644 --- a/packages/jest-mock/README.md +++ b/packages/jest-mock/README.md @@ -86,7 +86,7 @@ Sets the default mock implementation for the function. ##### `.mockReturnThis()` -Syntactic sugar for: +API sugar for: ```js mockFn.mockImplementation(function () { diff --git a/website/versioned_docs/version-25.x/MockFunctionAPI.md b/website/versioned_docs/version-25.x/MockFunctionAPI.md index 5bb3925c81a1..3da99d5e910c 100644 --- a/website/versioned_docs/version-25.x/MockFunctionAPI.md +++ b/website/versioned_docs/version-25.x/MockFunctionAPI.md @@ -199,7 +199,7 @@ Expected mock function "mockedFunction" to have been called, but it was not call ### `mockFn.mockReturnThis()` -Syntactic sugar function for: +API sugar function for: ```js jest.fn(function () { @@ -236,7 +236,7 @@ console.log(myMockFn(), myMockFn(), myMockFn(), myMockFn()); ### `mockFn.mockResolvedValue(value)` -Syntactic sugar function for: +API sugar function for: ```js jest.fn().mockImplementation(() => Promise.resolve(value)); @@ -254,7 +254,7 @@ test('async test', async () => { ### `mockFn.mockResolvedValueOnce(value)` -Syntactic sugar function for: +API sugar function for: ```js jest.fn().mockImplementationOnce(() => Promise.resolve(value)); @@ -279,7 +279,7 @@ test('async test', async () => { ### `mockFn.mockRejectedValue(value)` -Syntactic sugar function for: +API sugar function for: ```js jest.fn().mockImplementation(() => Promise.reject(value)); @@ -297,7 +297,7 @@ test('async test', async () => { ### `mockFn.mockRejectedValueOnce(value)` -Syntactic sugar function for: +API sugar function for: ```js jest.fn().mockImplementationOnce(() => Promise.reject(value)); diff --git a/website/versioned_docs/version-26.x/MockFunctionAPI.md b/website/versioned_docs/version-26.x/MockFunctionAPI.md index 5bb3925c81a1..3da99d5e910c 100644 --- a/website/versioned_docs/version-26.x/MockFunctionAPI.md +++ b/website/versioned_docs/version-26.x/MockFunctionAPI.md @@ -199,7 +199,7 @@ Expected mock function "mockedFunction" to have been called, but it was not call ### `mockFn.mockReturnThis()` -Syntactic sugar function for: +API sugar function for: ```js jest.fn(function () { @@ -236,7 +236,7 @@ console.log(myMockFn(), myMockFn(), myMockFn(), myMockFn()); ### `mockFn.mockResolvedValue(value)` -Syntactic sugar function for: +API sugar function for: ```js jest.fn().mockImplementation(() => Promise.resolve(value)); @@ -254,7 +254,7 @@ test('async test', async () => { ### `mockFn.mockResolvedValueOnce(value)` -Syntactic sugar function for: +API sugar function for: ```js jest.fn().mockImplementationOnce(() => Promise.resolve(value)); @@ -279,7 +279,7 @@ test('async test', async () => { ### `mockFn.mockRejectedValue(value)` -Syntactic sugar function for: +API sugar function for: ```js jest.fn().mockImplementation(() => Promise.reject(value)); @@ -297,7 +297,7 @@ test('async test', async () => { ### `mockFn.mockRejectedValueOnce(value)` -Syntactic sugar function for: +API sugar function for: ```js jest.fn().mockImplementationOnce(() => Promise.reject(value)); diff --git a/website/versioned_docs/version-27.x/MockFunctionAPI.md b/website/versioned_docs/version-27.x/MockFunctionAPI.md index 797536b24de5..f9995ee47a86 100644 --- a/website/versioned_docs/version-27.x/MockFunctionAPI.md +++ b/website/versioned_docs/version-27.x/MockFunctionAPI.md @@ -209,7 +209,7 @@ Expected mock function "mockedFunction" to have been called, but it was not call ### `mockFn.mockReturnThis()` -Syntactic sugar function for: +API sugar function for: ```js jest.fn(function () { @@ -246,7 +246,7 @@ console.log(myMockFn(), myMockFn(), myMockFn(), myMockFn()); ### `mockFn.mockResolvedValue(value)` -Syntactic sugar function for: +API sugar function for: ```js jest.fn().mockImplementation(() => Promise.resolve(value)); @@ -264,7 +264,7 @@ test('async test', async () => { ### `mockFn.mockResolvedValueOnce(value)` -Syntactic sugar function for: +API sugar function for: ```js jest.fn().mockImplementationOnce(() => Promise.resolve(value)); @@ -289,7 +289,7 @@ test('async test', async () => { ### `mockFn.mockRejectedValue(value)` -Syntactic sugar function for: +API sugar function for: ```js jest.fn().mockImplementation(() => Promise.reject(value)); @@ -307,7 +307,7 @@ test('async test', async () => { ### `mockFn.mockRejectedValueOnce(value)` -Syntactic sugar function for: +API sugar function for: ```js jest.fn().mockImplementationOnce(() => Promise.reject(value)); diff --git a/website/versioned_docs/version-28.0/MockFunctionAPI.md b/website/versioned_docs/version-28.0/MockFunctionAPI.md index db8f2d5ea4b3..be2ce406bccb 100644 --- a/website/versioned_docs/version-28.0/MockFunctionAPI.md +++ b/website/versioned_docs/version-28.0/MockFunctionAPI.md @@ -291,7 +291,7 @@ Expected mock function "mockedFunction" to have been called, but it was not call ### `mockFn.mockReturnThis()` -Syntactic sugar function for: +API sugar function for: ```js jest.fn(function () { @@ -355,7 +355,7 @@ mockFn(); // 'default' ### `mockFn.mockResolvedValue(value)` -Syntactic sugar function for: +API sugar function for: ```js jest.fn().mockImplementation(() => Promise.resolve(value)); @@ -381,7 +381,7 @@ test('async test', async () => { ### `mockFn.mockResolvedValueOnce(value)` -Syntactic sugar function for: +API sugar function for: ```js jest.fn().mockImplementationOnce(() => Promise.resolve(value)); @@ -421,7 +421,7 @@ test('async test', async () => { ### `mockFn.mockRejectedValue(value)` -Syntactic sugar function for: +API sugar function for: ```js jest.fn().mockImplementation(() => Promise.reject(value)); @@ -451,7 +451,7 @@ test('async test', async () => { ### `mockFn.mockRejectedValueOnce(value)` -Syntactic sugar function for: +API sugar function for: ```js jest.fn().mockImplementationOnce(() => Promise.reject(value)); diff --git a/website/versioned_docs/version-28.1/MockFunctionAPI.md b/website/versioned_docs/version-28.1/MockFunctionAPI.md index db8f2d5ea4b3..be2ce406bccb 100644 --- a/website/versioned_docs/version-28.1/MockFunctionAPI.md +++ b/website/versioned_docs/version-28.1/MockFunctionAPI.md @@ -291,7 +291,7 @@ Expected mock function "mockedFunction" to have been called, but it was not call ### `mockFn.mockReturnThis()` -Syntactic sugar function for: +API sugar function for: ```js jest.fn(function () { @@ -355,7 +355,7 @@ mockFn(); // 'default' ### `mockFn.mockResolvedValue(value)` -Syntactic sugar function for: +API sugar function for: ```js jest.fn().mockImplementation(() => Promise.resolve(value)); @@ -381,7 +381,7 @@ test('async test', async () => { ### `mockFn.mockResolvedValueOnce(value)` -Syntactic sugar function for: +API sugar function for: ```js jest.fn().mockImplementationOnce(() => Promise.resolve(value)); @@ -421,7 +421,7 @@ test('async test', async () => { ### `mockFn.mockRejectedValue(value)` -Syntactic sugar function for: +API sugar function for: ```js jest.fn().mockImplementation(() => Promise.reject(value)); @@ -451,7 +451,7 @@ test('async test', async () => { ### `mockFn.mockRejectedValueOnce(value)` -Syntactic sugar function for: +API sugar function for: ```js jest.fn().mockImplementationOnce(() => Promise.reject(value));