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.

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

chore(docs): add readme to jest-types #12791

Merged
merged 7 commits into from May 3, 2022
Merged
Changes from 2 commits
Commits
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
21 changes: 21 additions & 0 deletions packages/jest-types/README.md
@@ -0,0 +1,21 @@
# @jest/types

This package contains shared types of Jest's packages.

If you're a user of Jest and looking for types, you could import `@jest/globals`:

```typescript
rethab marked this conversation as resolved.
Show resolved Hide resolved
import { describe, it, expect } from '@jest/globals';

describe('my tests', () => {
it('works', () => {
expect(1).toBe(1);
});
});
```

If you don't want to import types, you could install the [@types/jest](https://www.npmjs.com/package/@types/jest) package.
This is not maintained by the Jest team though.


See https://github.com/facebook/jest/issues/9972 for more info.
rethab marked this conversation as resolved.
Show resolved Hide resolved