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.

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

Jump to bottom

Update options.md #1901

Open
wants to merge 2 commits into
base: docs
Choose a base branch
from
Open

Update options.md #1901

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
45a3c75
Update performance.md
cspotcode Jul 2, 2022
83cdcb1
Update options.md
sosoba Oct 19, 2022
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
2 changes: 2 additions & 0 deletions website/docs/options.md
View file
Open in desktop
Expand Up @@ -403,6 +403,8 @@ Requires [`esm`](#esm) to be enabled.

*Default:* `explicit`<br/>

This feature has been removed since Node 19 version.

## API Options

The API includes [additional options](https://typestrong.org/ts-node/api/interfaces/RegisterOptions.html) not shown here.
6 changes: 5 additions & 1 deletion website/docs/performance.md
View file
Open in desktop
Expand Up @@ -6,14 +6,18 @@ These tricks will make ts-node faster.

## Skip typechecking

It is often better to use `tsc --noEmit` to typecheck as part of your tests or linting. In these cases, ts-node can skip typechecking.
It is often better to typecheck as part of your tests or linting. You can use `tsc --noEmit` to do this. In these cases, ts-node can skip typechecking making it much faster.

To skip typechecking in ts-node, do one of the following:

* Enable [swc](./swc.md)
* This is by far the fastest option
* Enable [`transpileOnly`](./options.md#transpileonly) to skip typechecking without swc

## With typechecking

If you absolutely must use ts-node for typechecking:

* Avoid dynamic `require()` which may trigger repeated typechecking; prefer `import`
* Try with and without `--files`; one may be faster depending on your project
* Check `tsc --showConfig`; make sure all executed files are included
Expand Down