How to document a string type in jsdoc with limited possible values

by

As of late 2014 in jsdoc3 you have the possibility to write:

/**
 * @param {('rect'|'circle'|'ellipse')} shapeType - The allowed type of the shape
 */
Shape.prototype.getType = function (shapeType) {
  return this.type;
};

Of course this will not be as reusable as a dedicated enum but in many cases a dummy enum is an overkill if it is only used by one function.

See also: https://github.com/jsdoc3/jsdoc/issues/629#issue-31314808

More Related Contents:

  1. difference between “void 0 ” and “undefined”
  2. jQuery compiled with Google Closure Compiler
  3. Partially skip sections with Google Closure Compiler
  4. Google Apps Script Auto Generated Library Documentation
  5. How to describe “object” arguments in jsdoc?
  6. Exclude debug JavaScript code during minification
  7. Correct way to document open-ended argument functions in JSDoc
  8. How do I split my javascript into modules using Google’s Closure Compiler?
  9. Does it make sense to minify code used in NodeJS?
  10. Adding line breaks to c# comments for Intellisense [duplicate]
  11. Running a command in a Grunt Task
  12. Document generic type parameters in JSDOC

Leave a Comment