Skip to content

Commit

Permalink
chore(docs): add readme to jest-types (jestjs#12791)
Browse files Browse the repository at this point in the history
  • Loading branch information
rethab authored May 3, 2022
1 parent 28ae3dc commit 585854f
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions packages/jest-types/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# @jest/types

This package contains shared types of Jest's packages.

If you are looking for types of [Jest globals](https://jestjs.io/docs/api), you can import them from `@jest/globals` package:

```ts
import {describe, expect, it} from '@jest/globals';

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

If you prefer to omit imports, a similar result can be achieved installing the [@types/jest](https://npmjs.com/package/@types/jest) package. Note that this is a third party library maintained at [DefinitelyTyped](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/jest) and may not cover the latest Jest features.

Another use-case for `@types/jest` is a typed Jest config as those types are not provided by Jest out of the box:

```ts
// jest.config.ts
import {Config} from '@jest/types';

const config: Config.InitialOptions = {
// some typed config
};

export default config;
```

0 comments on commit 585854f

Please sign in to comment.