Skip to content
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

Jump to bottom

docs: mock sugar fns are for API, not syntax #13080

Closed
wants to merge 1 commit into from
Closed

docs: mock sugar fns are for API, not syntax #13080

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
10 changes: 5 additions & 5 deletions docs/MockFunctionAPI.md
View file
Open in desktop
Expand Up @@ -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:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
API sugar function for:
Shorthand for:

?


```js
jest.fn(function () {
Expand Down Expand Up @@ -355,7 +355,7 @@ mockFn(); // 'default'

### `mockFn.mockResolvedValue(value)`

Syntactic sugar function for:
API sugar function for:

```js
jest.fn().mockImplementation(() => Promise.resolve(value));
Expand All @@ -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));
Expand Down Expand Up @@ -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));
Expand Down Expand Up @@ -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));
Expand Down
2 changes: 1 addition & 1 deletion packages/jest-mock/README.md
View file
Open in desktop
Expand Up @@ -86,7 +86,7 @@ Sets the default mock implementation for the function.

##### `.mockReturnThis()`

Syntactic sugar for:
API sugar for:

```js
mockFn.mockImplementation(function () {
Expand Down
10 changes: 5 additions & 5 deletions website/versioned_docs/version-25.x/MockFunctionAPI.md
View file
Open in desktop
Expand Up @@ -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 () {
Expand Down Expand Up @@ -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));
Expand All @@ -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));
Expand All @@ -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));
Expand All @@ -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));
Expand Down
10 changes: 5 additions & 5 deletions website/versioned_docs/version-26.x/MockFunctionAPI.md
View file
Open in desktop
Expand Up @@ -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 () {
Expand Down Expand Up @@ -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));
Expand All @@ -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));
Expand All @@ -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));
Expand All @@ -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));
Expand Down
10 changes: 5 additions & 5 deletions website/versioned_docs/version-27.x/MockFunctionAPI.md
View file
Open in desktop
Expand Up @@ -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 () {
Expand Down Expand Up @@ -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));
Expand All @@ -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));
Expand All @@ -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));
Expand All @@ -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));
Expand Down
10 changes: 5 additions & 5 deletions website/versioned_docs/version-28.0/MockFunctionAPI.md
View file
Open in desktop
Expand Up @@ -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 () {
Expand Down Expand Up @@ -355,7 +355,7 @@ mockFn(); // 'default'

### `mockFn.mockResolvedValue(value)`

Syntactic sugar function for:
API sugar function for:

```js
jest.fn().mockImplementation(() => Promise.resolve(value));
Expand All @@ -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));
Expand Down Expand Up @@ -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));
Expand Down Expand Up @@ -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));
Expand Down
10 changes: 5 additions & 5 deletions website/versioned_docs/version-28.1/MockFunctionAPI.md
View file
Open in desktop
Expand Up @@ -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 () {
Expand Down Expand Up @@ -355,7 +355,7 @@ mockFn(); // 'default'

### `mockFn.mockResolvedValue(value)`

Syntactic sugar function for:
API sugar function for:

```js
jest.fn().mockImplementation(() => Promise.resolve(value));
Expand All @@ -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));
Expand Down Expand Up @@ -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));
Expand Down Expand Up @@ -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));
Expand Down