Make TypeScript declaration files usable in Node projects #48
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
PR gasparesganga#19 added a type declaration file for the library, but didn't add it in a way that TypeScript is able to find per https://www.typescriptlang.org/docs/handbook/module-resolution.html#how-typescript-resolves-modules . It's likely that in 2017 this was fine, but in 2022 it means code like this: ```TypeScript import "gasparesganga-jquery-loading-overlay"; ``` ... will not result in type definitions being included as well, which is annoying. This commit fixes this by taking the strategy outlined by https://www.typescriptlang.org/docs/handbook/declaration-files/publishing.html#including-declarations-in-your-npm-package where `package.json` is updated to point to the declaration file.
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.
PR #19 added a type declaration file for the library, but didn't add it in a way that TypeScript is able to find per https://www.typescriptlang.org/docs/handbook/module-resolution.html#how-typescript-resolves-modules.
It's likely that in 2017 this was fine, but in 2022 it means code like this:
... will not result in type definitions being included as well, which is annoying.
This commit fixes this by taking the strategy outlined by https://www.typescriptlang.org/docs/handbook/declaration-files/publishing.html#including-declarations-in-your-npm-package where
package.jsonis updated to point to the declaration file.