Fix published types #284
Merged
Fix published types #284
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
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.
When using this package with TypeScript most of the more critical types don't work (I especially noticed this with the types related to callback arguments).
This is because most of the types are in a
types.d.tsfile in the root of the repo, but TypeScript is configured with"baseUrl": ".", so what ends up in thedistdirectory has the same structure as the repo.This means that in the the published package you end up with the main
Proxyclass indist/lib/proxy.js, and it's types indist/lib/proxy.d.ts, but those types are attempting to import from../types, which doesn't exist because thattypes.d.tsis not listed in theincludelist intsconfig.json(and it wouldn't be included in the build anyway, since it's an ambient declaration file).All this PR does is to relocate that types file into the
libdirectory and change it from an ambient declaration to a regular.tsfile so that it will get included in the build and make the types usable from the published package.