feat: Export types used in the public interface (#22) #51
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
Any type (class, interface, literal type, etc) that's used by Lambda Express' public API as a method return type, parameter type, or property type must be exported on `src/index.ts` so that it's available to be used in client code.
1 similar comment
yokuze
commented
Apr 16, 2019
| StringUnknownMap, | ||
| KeyValueStringObject, | ||
| StringArrayOfStringsMap, | ||
| } from '@silvermine/toolbox'; |
There was a problem hiding this comment.
At first glance, it may seem odd to just re-export types from '@silvermine/toolbox', but I did this for two reasons:
- If we don't, then we'd be forcing clients of
lambda-expressto depend on'@silvermine/toolbox'directly if they want access to those types. - A client may already depend on
'@silvermine/toolbox'in their code, but at a different version with a different API. This would allow them to use the types from'@silvermine/toolbox'that their version oflambda-expressuses internally as needed, and the types from their version of'@silvermine/toolbox'.
yokuze
commented
Apr 16, 2019
| @@ -9,3 +9,37 @@ export { | |||
| Response, | |||
| Router, | |||
| }; | |||
|
|
|||
| // We need to export only types that are used in public interfaces (e.g. those used in | |||
There was a problem hiding this comment.
FWIW, I doubled-checked this list against the output from Microsoft's API Extractor tool to ensure that all of the types used in the public API are exported here, but I opened #49 to make considering integrating that tool a separate task. Integrating it will not be simple, and I'm not certain it will even completely meet our needs (it doesn't support literal type definitions, etc).
jthomerson
approved these changes
Apr 16, 2019
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.
Any type (class, interface, literal type, etc) that's used by Lambda
Express' public API as a method return type, parameter type, or property
type must be exported on
src/index.tsso that it's available to beused in client code.