Convert field bracketed arrays to type generics for JSDocs compatibility #363
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.
JSDocs does not handle
Type[]
syntax correctly when used as a field (an object attribute or an optional function parameter).The problematic behavior is apparent in our return types that include cursors:
data
is an Array- of what?Switching to
Array<Type>
syntax, JSDocs cooperates and shows that it is an array ofGroupJoinRequests
with a corresponding hyperlink:I have also fixed a number of types that were capitalized (
Number
->number
), and array parameters with no types defined.Returns using bracketed syntax do not need to be changed.
This pull request only affects JSDocs documentation,
index.d.ts
did not require modification.