Enum as @param type in JSDoc

Question

Is it possible to use an enum for the JSDoc @param type declaration like in the following example?

/**  * @enum { Number }  */ var TYPES = {     TYPE_A: 1,     TYPE_B: 2 }  /**  * @param { TYPES } type  */ function useTypesEnum( type ) {  } 

If I use an IDE like Eclipse etc. for JavaScript, there should no warning be raised?

Answer 1

You can achieve that, by doing this:

/** * @param {(1|2)} type */ function useTypesEnum(type) {  } 

Answer 2

So it seems this is the right way to document everything without any warning

/**  * @typedef {number} MyType  **/   /**  * @enum {MyType}  */ var TYPES = {     TYPE_A: 1,     TYPE_B: 2 }  /**  * @param {MyType} type  */ function useTypesEnum( type ) {  } 

This means:

• MyType is a number
• TYPES is an enum that holds MyType values
• This function accepts enums that output MyType values

Works for me on intellij 2017.1

However - this will still allow each string to be passed to the function without warnings.

If you want to specify the enum values too - so it should raise errors if another string was used, use the method described at: https://stackoverflow.com/a/36501659/1068746

 /**     * @typedef FieldType     * @property {string} Text "text"     * @property {string} Date "date"     * @property {string} DateTime "datetime"     * @property {string} Number "number"     * @property {string} Currency "currency"     * @property {string} CheckBox "checkbox"     * @property {string} ComboBox "combobox"     * @property {string} Dropdownlist "dropdownlist"     * @property {string} Label "label"     * @property {string} TextArea "textarea"     * @property {string} JsonEditor "jsoneditor"     * @property {string} NoteEditor "noteeditor"     * @property {string} ScriptEditor "scripteditor"     * @property {string} SqlEditor "sqleditor"     */