Correct way to document open-ended argument functions in JSDoc

by

The JSDoc specs and Google’s Closure Compiler do it this way:

@param {...number} var_args

Where “number” is the type of arguments expected.

The complete usage of this, then, would look like the following:

/**
* @param {...*} var_args
*/
function lookMaImVariadic(var_args) {
    // Utilize the `arguments` object here, not `var_args`.
}

Note the comment about utilizing arguments (or some offset of arguments) to access your additional arguments. var_args it just used to signal to your IDE that the argument does indeed exist.

Rest parameters in ES6 can take the real parameter one step further to encompass provided values (so no more use of arguments is necessary):

/**
* @param {...*} var_args
*/
function lookMaImES6Variadic(...var_args) {
    // Utilize the `var_args` array here, not `arguments`.
}

More Related Contents:

  1. How to describe “object” arguments in jsdoc?
  2. Document generic type parameters in JSDOC
  3. Calculate Javascript pixel widths for list of elements
  4. javascript function doesn’t work when link is clicked
  5. Pass variables by reference in JavaScript
  6. How can I group data with an Angular filter?
  7. Is it wrong to place the tag after the tag?
  8. JavaScript/JQuery: $(window).resize how to fire AFTER the resize is completed?
  9. Parse DateTime string in JavaScript
  10. Why am I getting a ReferenceError: AbortController is not defined in Discord.js v13?
  11. Count number of matches of a regex in Javascript
  12. canvas.toDataURL() SecurityError
  13. Google Map API v3 — set bounds and center
  14. How can I disable a browser or element scrollbar, but still allow scrolling with wheel or arrow keys?
  15. Common sources of unterminated string literal [duplicate]
  16. JavaScript data formatting/pretty printer
  17. Javascript Method Naming lowercase vs uppercase
  18. require is not defined error with browserify
  19. JavaScript window.location does not set referer in the request header
  20. Select a printer and silently print
  21. Is there any way to accelerate the mousemove event?
  22. Search a JavaScript object
  23. Using JavaScript what’s the quickest way to recursively remove properties and values from an object?
  24. Change tag using javascript [duplicate]
  25. Solving TicTacToe with minimax algorithm in Javascript
  26. Passing props with programmatic navigation Vue.js
  27. JavaScript Regex to match a URL in a field of text
  28. How to properly use useHistory () from react-router-dom?
  29. how to animate drawing lines on canvas
  30. What is the difference between these Backbone/Underscore .bind() methods?

Leave a Comment