How to JsDoc a “mixed” type?

前端 未结 3 846
时光说笑
时光说笑 2021-02-11 14:46

Simple question, how do I document that \"Mixed-type\"? I know I could just list all possible types like {null|undefined|String|Number|Object} and end up finding my

3条回答
  •  清酒与你
    2021-02-11 15:53

    In JSDoc, you can describe values in different ways. For example, using the following tags @type, @param, @return. You can specify optional values using the "?". Here is an example

        /**
         * Returns string or null
         *
         * @param {?string} nullableStringArgument
         *
         * @return {?string}
         */
        function returnNullableString (nullableStringArgument = null) {
            /** @type {?string} */
            const nullableString = [null, 'string'][Math.floor(Math.random() * 2)];
    
            return nullableString;
        }
    

提交回复
热议问题