Update readme.md to include a note about dev mode install #851
+7
−0
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
| @@ -75,6 +75,13 @@ PR welcome for additional commonly needed types and docs improvements. Read the | |||
| npm install type-fest | |||
| ``` | |||
|
|
|||
| <p>Or, for projects that do not export these or dependent types, install as a dev only dependency with: </p> | |||
There was a problem hiding this comment.
This is not entirely accurate. The types don't need to be exported for it to need to be a dependency, and not dev dependency. Even if the types are used internally in a index.d.ts file (and not exported), type-fest needs to a dependency. Basically, if types included in a package use types from type-fest, type-fest needs to be a dependency.
There was a problem hiding this comment.
Unless one explicitly add an ignore to the imports, then they become optional imports, see eg this helper of mine: https://github.com/voxpelli/ts-ignore-import
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.
Quick update to the README for the question posted at #136 since I am least the second to newb to ask.