enhancement(types): rename and export API-related types #72
Conversation
This file contains hidden or 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
Convly
added
pr: enhancement
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
What does it do?
Export an API type namespace that contains related types
Documentrepresents a generic document with common fields and any other propertyDocumentResponseis a core API response for a document (data/meta), it accepts a Document-like paramDocumentResponseCollectionis the same asDocumentResponsebut data is an arrayBaseQueryParamsis the generic type version of the core API query paramsWhy is it needed?
Expose those common types to improve the overall developer experience when using the client
How to test it?
Use the node-typescript demo to see how those types can be used
Related issue(s)/PR(s)
fix #53