Skip to content

Commit

Permalink
Update
Browse files Browse the repository at this point in the history
  • Loading branch information
smaye81 committed Aug 11, 2023
1 parent 23f4b19 commit 0e88d4c
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,30 @@
An extension of [jest-environment-jsdom](https://www.npmjs.com/package/jest-environment-jsdom)
with support for the [Encoding API](https://developer.mozilla.org/en-US/docs/Web/API/Encoding_API).

## Installation

Note that `jest-environment-jsdom` is still required as a peer dependency:

```bash
npm install --save-dev jest-environment-jsdom @bufbuild/jest-environment-jsdom
```

## Usage

Update the `testEnvironment` property of your Jest config like so:

```diff
import type { Config } from 'jest';

const config: Config = {
- testEnvironment: 'jsdom',
+ testEnvironment: '@bufbuild/jest-environment-jsdom',
...
};
```

Full documentation can be found in the package [README](packages/jest-environment-jsdom).

## Packages

- [@bufbuild/jest-environment-jsdom](https://www.npmjs.com/package/@bufbuild/jest-environment-jsdom)
Expand Down

0 comments on commit 0e88d4c

Please sign in to comment.