docs: add readme, instructions and explanation #6
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tobiashochguertel
previously approved these changes
Mar 18, 2024
kettanaito
reviewed
Mar 18, 2024
kettanaito
reviewed
Mar 18, 2024
kettanaito
changed the title
kettanaito
reviewed
Mar 18, 2024
kettanaito
reviewed
Mar 18, 2024
README.md
Outdated
|
|
||
| ## Motivation | ||
|
|
||
| Jest strips out a number of NodeJS globals that are used in tests and libraries involving JSDOM, such as structuredClone, ReadableStream, and so on. This library patches these globals back in - there is no polyfilling or mocking involved, it simply re-attaches the missing globals to the JSDOM environment. If you've ever come across errors such as `ReferenceError: ReadableStream is not defined` or `ReferenceError: structuredClone is not defined`, this library is for you. If you were previously using (undici)[https://www.npmjs.com/package/undici] purely to solve this, you will no longer need it. |
There was a problem hiding this comment.
This is not entirely correct. There are a few things that happen in the Jest/JSDOM combo:
- Some globals are stripped away, like
ReadableSteam,TextEncoder,TextDecoder. - Some globals are present but are polyfilled by JSDOM or other libraries, making them incompatible with Node.js, e.g.
EventandstructuredClone().
If you want, I can help you rewrite this section. Let me know.
joel-daros
previously approved these changes
Mar 18, 2024
kettanaito
reviewed
Mar 18, 2024
README.md
Outdated
|
|
||
| You will need to add/modify two properties in your jest configuration to use jest-fixed-jsdom. | ||
|
|
||
| ```json |
There was a problem hiding this comment.
Would be nice to add a comment that mentions what file this is (jest.config.js).
kettanaito
force-pushed
the
readme-firstpass
branch
from
5dd1c3f
to
6ba5b76
Compare
kettanaito
force-pushed
the
readme-firstpass
branch
from
6ba5b76
to
c71d538
Compare
kettanaito
approved these changes
Mar 18, 2024
|
I've polished the readme a bit. Thank you for your work on this, @JamesZoft @tobiashochguertel! 👏 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.