-
-
Notifications
You must be signed in to change notification settings - Fork 311
fix jsdoc @param union type support & @returns * all type support #95
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
Conversation
|
Two weeks gone, is there anyone maintaining this package's upgrade? Need this pr to be merged badly! |
|
Sorry, I've been on vacation for exactly two weeks :) |
| returns: null, | ||
| params: [{ | ||
| name: 'bar', | ||
| type: {name: 'string|Object'}, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm wondering if this shouldn't rather be something like {name: 'union', value: ['string', 'Object']}. What do you think @janicduplessis?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree we should keep this as an object since it's easier to use after. We should try to have a similar output object as the flow type definitions.
/**
* @param test Test
*/
function (test: string | Object) {}and
/**
* @param {string | Object} test Test
*/
function (test) {}should result in the same thing.
You could take a look at what the object we return for flow types look like and return something similar.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
OK, I'll update the commit soon.
|
Another week gone, so when will this to be merged and when will next version to be published? |
|
Sorry for the slow progress here, the last couple of weeks just had been really busy (I was traveling most of the time). If we want to stay compatible with flow types, I think |
|
OK, thank you for your suggestion, I've updated the commit~ |
|
👍 |
No description provided.