Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Convert field bracketed arrays to type generics for JSDocs compatibility #363

Merged
merged 1 commit into from
Jun 14, 2021

Conversation

alanbixby
Copy link
Member

@alanbixby alanbixby commented Jun 11, 2021

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:

image

data is an Array- of what?

Switching to Array<Type> syntax, JSDocs cooperates and shows that it is an array of GroupJoinRequests with a corresponding hyperlink:

image

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.

@suufi suufi closed this Jun 14, 2021
@suufi suufi reopened this Jun 14, 2021
@suufi suufi merged commit b1bf9d7 into noblox:master Jun 14, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants