Support includes_description in listStories #94
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
iwillig
approved these changes
Mar 1, 2021
src/index.ts
Outdated
| return this.listResource(`projects/${projectID}/stories`); | ||
| listStories( | ||
| projectID: ID, | ||
| includesDescription: boolean, |
There was a problem hiding this comment.
Oops, nice catch!
This is working fine as includesDescription will be undefined and converted as a boolean below, but let's make it explicit to avoid confusion here.
| .then(this.responseParser.parseResponse); | ||
| listResource<T>( | ||
| uri: string, | ||
| params?: Record<string, any> | null | undefined, |
There was a problem hiding this comment.
Yes, sort of. Record<Keys, Type> is an elegant way of typing objects.
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.
Resolves #80.
List Storiesis returning an array ofStorySlimand by default, thedescriptionfield isn't included. We can support this by passingincludes_descriptionas an argument.