Add global type defs #37
Merged
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
robwierzbowski
force-pushed
the
KFE-438
branch
from
bb1c405 to
4979595
Compare
benmvp
approved these changes
Aug 30, 2021
There was a problem hiding this comment.
Left some small, non-blocking suggestions about updating the comments. Otherwise, this looks great. Thanks for taking the time to do this!
I know both home-ui & shop-collections-ui had to add the dummy module, so it'd be good to socialize this with @brandon-vaughan & @halloffame
src/stitch_fix/generateId.js
Outdated
| @@ -1,6 +1,8 @@ | |||
| import { ulid } from 'ulid'; | |||
| import { constantCase } from 'constant-case'; | |||
|
|
|||
| // Keep the type signature of this function in sync with the types exposed in | |||
| // index.d.ts | |||
There was a problem hiding this comment.
this is actually now in generateId.d.ts. i would also add a companion comment in generateId.d.ts to mention that it has to be kept in sync w/ the source file
| @@ -1,6 +1,8 @@ | |||
| import { ulid } from 'ulid'; | |||
| import { constantCase } from 'constant-case'; | |||
|
|
|||
| // Keep the type signature of this function in sync with the types exposed in | |||
| // index.d.ts | |||
| const generateId = (key) => { | |||
| if (typeof key === 'undefined') { | |||
There was a problem hiding this comment.
the nice thing is that a TS app now won't let the key be undefined thanks to these type definitions.
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.
Problem
Although the JS package isn't written in TS, it's a pain for TS apps to add a module declaration file when they need to use it. The types also need to be exposed through packages like ER that are in TS, and are consumed by TS apps.
Solution
Expose a global TS module def. Check in a TS aware application that this works as expected when importing Log Weasel directly.
TODO
After merge: