Skip to content

docs: advise users to install typescript types #460

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
wants to merge 4 commits into from
Closed

docs: advise users to install typescript types #460

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
64d7fda
docs: advise users to install typescript types
waynevanson May 19, 2022
a309153
Merge branch 'main' into patch-1
nickserv Sep 19, 2022
8d97362
docs: advise pnpm users to install typescript types
nickserv Sep 19, 2022
bb669e6
docs(types): add note regarding explicit package managers
waynevanson Sep 21, 2022
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
17 changes: 17 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,23 @@ setupFilesAfterEnv: ['<rootDir>/jest-setup.js']

### With TypeScript

Install the Typescript types via your package manager, and usually only needs to be done when your package manager requires all dependencies explicitly installed (pnpm, yarn@>=2).

```sh
# for npm
npm install -D @types/testing-library__jest-dom
```

```sh
# for yarn
yarn add -D @types/testing-library__jest-dom
```

```sh
# for pnpm
pnpm add -D @types/testing-library__jest-dom
```

If you're using TypeScript, make sure your setup file is a `.ts` and not a `.js`
to include the necessary types.

Expand Down