Document the JSDoc @import tag #3170
Open
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
This replaces the documentation for using `@typedef` and `import()` to alias a type.
jakebailey
added
the
deploy-preview
|
Azure Static Web Apps: Your stage site is ready! Visit it here: https://victorious-plant-05c166c10-3170.centralus.5.azurestaticapps.net |
DanielRosenwasser
requested changes
Jun 28, 2024
| @@ -240,6 +221,28 @@ export const userAccount = { | |||
| var x = require("./accounts").userAccount; | |||
| ``` | |||
|
|
|||
| ### `@import` | |||
|
|
|||
| `@import` can be used for type-only imports: | |||
There was a problem hiding this comment.
Suggested change
| `@import` can be used for type-only imports: | |
| The `@import` tag can lets us reference exports from other files. |
Comment on lines
+244
to
+245
| ``` | ||
|
|
There was a problem hiding this comment.
Suggested change
| ``` | |
| ``` | |
| These tags don't actually import files at runtime, and the symbols they bring into scope can only be used within JSDoc comments for type-checking. | |
| ```js twoslash | |
| // @filename: dog.js | |
| export class Dog { | |
| woof() { | |
| console.log("Woof!"); | |
| } | |
| } | |
| // @filename: main.js | |
| /** @import { Dog } from "./dog.js"; | |
| const d = new Dog(); // error! |
You'll need to add the appropriate expected error to that code block though.
Closed
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.
This replaces the documentation for using
@typedefandimport()to alias a type.