We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
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
If I set NaN as a default param value (see param 3 below)...
NaN
/** * Example. * * @param {number} arg1=1 * @param {number} arg2=something * @param {number} arg3=NaN */ function example (arg1, arg2, arg3) {}
...then, in the explain output the defaultValue is returned as null - a different value.
null
[ { "comment": "/**\n * Example.\n *\n * @param {number} arg1=1\n * @param {number} arg2=something\n * @param {number} arg3=NaN\n */", "meta": { "range": [ 111, 149 ], "filename": "issue-170.js", "lineno": 8, "columnno": 0, "path": "/Users/llobrook/Documents/jsdoc2md/testbed/tmp", "code": { "id": "astnode100000002", "name": "example", "type": "FunctionDeclaration", "paramnames": [ "arg1", "arg2", "arg3" ] } }, "description": "Example.", "params": [ { "type": { "names": [ "number" ] }, "defaultvalue": 1, "name": "arg1" }, { "type": { "names": [ "number" ] }, "defaultvalue": "something", "name": "arg2" }, { "type": { "names": [ "number" ] }, "defaultvalue": null, "name": "arg3" } ], "name": "example", "longname": "example", "kind": "function", "scope": "global" }, { "kind": "package", "longname": "package:undefined", "files": [ "/Users/llobrook/Documents/jsdoc2md/testbed/tmp/issue-170.js" ] } ]
Is it possible to represent NaN correctly in the returned explain JSON?
The text was updated successfully, but these errors were encountered:
Is it safe to assume the null value should be interpreted as NaN if one of the type names for that param is number?
number
Sorry, something went wrong.
No branches or pull requests
If I set
NaN
as a default param value (see param 3 below)......then, in the explain output the defaultValue is returned as
null
- a different value.Is it possible to represent
NaN
correctly in the returned explain JSON?The text was updated successfully, but these errors were encountered: