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

Incorrect JSDoc type information for optional parameters #278

Open
BribeFromTheHive opened this issue Jun 30, 2023 · 0 comments
Open

Incorrect JSDoc type information for optional parameters #278

BribeFromTheHive opened this issue Jun 30, 2023 · 0 comments

Comments

@BribeFromTheHive
Copy link

BribeFromTheHive commented Jun 30, 2023

Hi,

In functions such as gzip, the type information on the second parameter is not formatted for JSDoc. When using a TypeScript environment, it asks for the second parameter to be fulfilled. Please either add options={} syntax so that the function header recognizes the optional nature of the second parameter, or use JSDoc notation so they are declared accordingly:

/**
 * @param {Uint8Array|ArrayBuffer|string} data
 * @param {object} [options]
*/
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

No branches or pull requests

1 participant