Skip to content

docs: update Module Resolution.md #2864

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

Closed
wants to merge 1 commit into from
Closed

docs: update Module Resolution.md #2864

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 8 additions & 4 deletions packages/documentation/copy/en/reference/Module Resolution.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,12 +140,14 @@ TypeScript will mimic the Node.js run-time resolution strategy in order to locat
To accomplish this, TypeScript overlays the TypeScript source file extensions (`.ts`, `.tsx`, and `.d.ts`) over Node's resolution logic.
TypeScript will also use a field in `package.json` named `types` to mirror the purpose of `"main"` - the compiler will use it to find the "main" definition file to consult.

Please note that the field `typings` is equivalent to `types` and can be used interchangeably. Thus, it is permissible for `package.json` to contain any of the two fields.

For example, an import statement like `import { b } from "./moduleB"` in `/root/src/moduleA.ts` would result in attempting the following locations for locating `"./moduleB"`:

1. `/root/src/moduleB.ts`
2. `/root/src/moduleB.tsx`
3. `/root/src/moduleB.d.ts`
4. `/root/src/moduleB/package.json` (if it specifies a `types` property)
4. `/root/src/moduleB/package.json` (if it specifies a `types` or `typings` property)
5. `/root/src/moduleB/index.ts`
6. `/root/src/moduleB/index.tsx`
7. `/root/src/moduleB/index.d.ts`
Expand All @@ -158,7 +160,7 @@ So `import { b } from "moduleB"` in source file `/root/src/moduleA.ts` would res
1. `/root/src/node_modules/moduleB.ts`
2. `/root/src/node_modules/moduleB.tsx`
3. `/root/src/node_modules/moduleB.d.ts`
4. `/root/src/node_modules/moduleB/package.json` (if it specifies a `types` property)
4. `/root/src/node_modules/moduleB/package.json` (if it specifies a `types` or `typings` property)
5. `/root/src/node_modules/@types/moduleB.d.ts`
6. `/root/src/node_modules/moduleB/index.ts`
7. `/root/src/node_modules/moduleB/index.tsx`
Expand All @@ -167,7 +169,7 @@ So `import { b } from "moduleB"` in source file `/root/src/moduleA.ts` would res
9. `/root/node_modules/moduleB.ts`
10. `/root/node_modules/moduleB.tsx`
11. `/root/node_modules/moduleB.d.ts`
12. `/root/node_modules/moduleB/package.json` (if it specifies a `types` property)
12. `/root/node_modules/moduleB/package.json` (if it specifies a `types` or `typings` property)
13. `/root/node_modules/@types/moduleB.d.ts`
14. `/root/node_modules/moduleB/index.ts`
15. `/root/node_modules/moduleB/index.tsx`
Expand All @@ -176,7 +178,7 @@ So `import { b } from "moduleB"` in source file `/root/src/moduleA.ts` would res
17. `/node_modules/moduleB.ts`
18. `/node_modules/moduleB.tsx`
19. `/node_modules/moduleB.d.ts`
20. `/node_modules/moduleB/package.json` (if it specifies a `types` property)
20. `/node_modules/moduleB/package.json` (if it specifies a `types` or `typings` property)
21. `/node_modules/@types/moduleB.d.ts`
22. `/node_modules/moduleB/index.ts`
23. `/node_modules/moduleB/index.tsx`
Expand Down Expand Up @@ -414,6 +416,8 @@ File 'node_modules/typescript/lib/typescript.d.ts' exist - use it as a module re

> 'package.json' has **'types'** field './lib/typescript.d.ts' that references 'node_modules/typescript/lib/typescript.d.ts'.

Note that 'types' is equivalent to 'typings' and can be used interchangeably. Thus the output may contain either of the two fields.

- Final result

> ======== Module name 'typescript' was **successfully resolved** to 'node_modules/typescript/lib/typescript.d.ts'. ========
Expand Down