Fixed typo in Modules.md #2580
Closed
Fixed typo in Modules.md #2580
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
The example tried to import `hello.js` from `hello.ts`. This page is missing sections on `package.json` and `tsconfig.json`. If you have these misconfigured then your modules won't work. Please add sections explaining what's needed. I'm not an expert on this, all I know is that `package.json` needs to have `"type": "module",` and `tsconfig.json` needs to have `"module": "ESNext",` and `"target": "ESNext"`. I'll start two sections at the bottom of the page, please complete these sections.
|
@microsoft-github-policy-service agree |
1 similar comment
|
@microsoft-github-policy-service agree |
jakebailey
requested changes
May 18, 2023
| @@ -72,7 +72,7 @@ export default function helloWorld() { | |||
| } | |||
| // @filename: index.ts | |||
| // ---cut--- | |||
| import helloWorld from "./hello.js"; | |||
| import helloWorld from "./hello.ts"; | |||
There was a problem hiding this comment.
We definitely do not want to be sticking .ts imports into our examples.
jakebailey
reviewed
May 18, 2023
|
|
||
| ## package.json | ||
|
|
||
| To use modules your `package.json` must include `"type": "module",`. For example, |
There was a problem hiding this comment.
This looks to be covered by https://www.typescriptlang.org/docs/handbook/esm-node.html, right? Maybe we just need links if we don't have them already?
|
Thank you for the effort, but this topic really can’t be wedged into this page as-is. It’s going to require a total rewrite, which is in progress at microsoft/TypeScript#52593. |
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.
The example tried to import
hello.jsfromhello.ts.This page is missing sections on
package.jsonandtsconfig.json. If you have these misconfigured then your modules won't work. Please add sections explaining what's needed. I'm not an expert on this, all I know is thatpackage.jsonneeds to have"type": "module",andtsconfig.jsonneeds to have"module": "ESNext",and"target": "ESNext". I'll start two sections at the bottom of the page, please complete these sections.