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.

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

Conversation

HamdaanAliQuatil
Copy link

Closes #2863

- What I did

Update Module Resolution.md to include clarification that types and typings are synonymous during module resolution in TypeScript.

- How I did it

  • Added a note under "How TypeScript resolves modules" mentioning typings is also permissible in package.json
  • Under relative import pt. 4, mentioned typings within parenthesis.
  • Under non-relative import pt. 4, 12, and 20, mentioned typings within parenthesis.
  • Added a note under "Things to look out for" pt 3, indicating that the output may contain a typings field.

@HamdaanAliQuatil HamdaanAliQuatil changed the title docs: update module resolution.md to include clarification for types and typings docs: update Module Resolution.md Jun 25, 2023
@orta
Copy link
Contributor

orta commented Jun 30, 2023

Typings is the older and largely deprecated name for this field, I feel like the team discussed this and opted to not include it in a few places during the tsconfig refernce also - so this PR probably isn't neededIMO

@jakebailey jakebailey closed this Jun 30, 2023
@jakebailey
Copy link
Member

Yeah; I don't think we want anyone using typings at this point.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs: "types" and "typings" are synonymous in Module Resolution.md
3 participants