Thanks to visit codestin.com
Credit goes to github.com

Skip to content

docs: Fixed incorrect docs regarding synchronous fallback for unimple… #14056

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

Merged
merged 6 commits into from
Apr 9, 2023
Merged

docs: Fixed incorrect docs regarding synchronous fallback for unimple… #14056

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
21463ac
docs: Fixed incorrect docs regarding synchronous fallback for unimple…
Mike-Dax Apr 5, 2023
6fb22e3
chore: Updated changelog
Mike-Dax Apr 5, 2023
eaa4b65
docs: Cleaned up language surrounding synchronous vs asynchronous tra…
Mike-Dax Apr 6, 2023
18bbd02
docs: Further cleanup of async transform language
Mike-Dax Apr 7, 2023
c70b068
docs: Applied async transform language changes to historical docs
Mike-Dax Apr 8, 2023
658f2dc
prettier
SimenB Apr 9, 2023
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
Prev Previous commit
Next Next commit
docs: Further cleanup of async transform language
  • Loading branch information
@Mike-Dax
Mike-Dax committed Apr 7, 2023
commit 18bbd0258f169331867dbdd08c2859f6f5305f5a
2 changes: 1 addition & 1 deletion docs/CodeTransformation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ The definitions above were trimmed down for brevity. Full code can be found in [

There are a couple of ways you can import code into Jest - using Common JS (`require`) or ECMAScript Modules (`import` - which exists in static and dynamic versions). Jest passes files through code transformation on demand (for instance when a `require` or `import` is evaluated). This process, also known as "transpilation", might happen _synchronously_ (in the case of `require`), or _asynchronously_ (in the case of `import` or `import()`, the latter of which also works from Common JS modules). For this reason, the interface exposes both pairs of methods for asynchronous and synchronous processes: `process{Async}` and `getCacheKey{Async}`. The latter is called to figure out if we need to call `process{Async}` at all.

Asynchronous transpilation can fall back to the synchronous `process` call if `processAsync` is unimplemented, but synchronous transpilation cannot use the asynchronous `processAsync` call if `process` is unimplemented. If your codebase is ESM only, implementing the async variants are sufficient. Otherwise, if any code is loaded through `require` (including `createRequire` from within ESM), then you need to implement the synchronous variant.
Asynchronous transpilation can fall back to the synchronous `process` call if `processAsync` is unimplemented, but synchronous transpilation cannot use the asynchronous `processAsync` call. If your codebase is ESM only, implementing the async variants are sufficient. Otherwise, if any code is loaded through `require` (including `createRequire` from within ESM), then you need to implement the synchronous `process` variant.

Be aware that `node_modules` is not transpiled with default config, the `transformIgnorePatterns` setting must be modified in order to do so.

Expand Down