intuit / oauth-jsclient

Intuit's NodeJS OAuth client provides a set of methods to make it easier to work with OAuth2.0 and Open ID
https://developer.intuit.com/
Apache License 2.0
121 stars 156 forks source link

JSDoc wrongly describes IntuitOauth constructor argument #76

Closed AlbertHambardzumyan closed 4 years ago

AlbertHambardzumyan commented 4 years ago

Describes as constructor JSDoc However, it suppose to be constructor doc

Thus, editor complains when we have

 new IntuitOauth({
  clientId: '',
  clientSecret: ''
  environment: '',
  redirectUri: ''
})
abisalehalliprasan commented 4 years ago

I am not following you. could you send a PR ?

AlbertHambardzumyan commented 4 years ago

@abisalehalliprasan Don't hurry to close the issue. Moreover, you could not follow it. People spend time to point out the bugs, please appreciate that.

You have a wrong JSDoc here

/**
 * @constructor
 * @param {string} config.environment
 * @param {string} config.appSecret
 * @param {string} config.appKey
 * @param {string} [config.cachePrefix]
 */
function OAuthClient(config) {
  ...
}
abisalehalliprasan commented 4 years ago

@AlbertHambardzumyan : I understand your concern here. But if you are not going to provide more details it will not help in getting the issue resolved.

If you think there is something wrong here could you add a PR to fix this?

AlbertHambardzumyan commented 4 years ago

@abisalehalliprasan As you see, I have spent more time and provided more details. However, the issue itself is closed already. That's weird to ask for a PR, but close the issue at the same time.

If something is not clear enough yet, it does not mean the issue can be considered as resolved by simply closing it. This is unexceptable.

Never mind. Thats already clear to me that some other tool should be used instead of this one. Again, this is unexceptable. No one does this in a way you do.