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: Reword 3-argument jest.spyOn description #5255

Merged
merged 4 commits into from
Jan 9, 2018
Merged

docs: Reword 3-argument jest.spyOn description #5255

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
71ce740
docs: Reword spyOn with accessType
thymikee Jan 8, 2018
76f9a8d
Run lint on .md files
thymikee Jan 9, 2018
738d9e8
Shift comments placement
thymikee Jan 9, 2018
fd9d6a3
Update CHANGELOG.md
SimenB Jan 9, 2018
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 docs/JestObjectAPI.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -420,9 +420,9 @@ test('plays video', () => {
```

### `jest.spyOn(object, methodName, accessType?)`
##### available in Jest **x.x.x+**
##### available in Jest **22.1.0+**

Since Jest x.x.x+, the `jest.spyOn` method takes an optional third argument that can be `'get'` or `'get'` in order to install a spy as a getter or a setter respectively. This is also needed when you need a spy an existing getter/setter method.
Since Jest 22.1.0+, the `jest.spyOn` method takes an optional third argument of `accessType` that can be either `'get'` or `'set'`, which proves to be useful when you want to spy on a getter or a setter, respectively.

Example:

Expand Down