fix jsdoc @param union type support & @returns * all type support (#95)

Fix jsdoc @param union type support & @returns

Author: 弘树

src/utils/__tests__/parseJsDoc-test.js

@@ -64,6 +64,21 @@ describe('parseJsDoc', () => {
       });
     });
 
+    it('extracts jsdoc union type param', () => {
+      const docblock = `
+        @param {string|Object} bar
+      `;
+      expect(parseJsDoc(docblock)).toEqual({
+        description: null,
+        returns: null,
+        params: [{
+          name: 'bar',
+          type: {name: 'union', value: ['string', 'Object']},
+          description: null,
+        }],
+      });
+    });
+
     it('extracts jsdoc optional', () => {
       const docblock = `
         @param {string=} bar
@@ -107,6 +122,20 @@ describe('parseJsDoc', () => {
         });
       });
 
+      it('extracts jsdoc mixed types', () => {
+        const docblock = `
+          @returns {*}
+        `;
+        expect(parseJsDoc(docblock)).toEqual({
+          description: null,
+          returns: {
+            type: {name: 'mixed'},
+            description: null,
+          },
+          params: [],
+        });
+      });
+
       it('extracts description from jsdoc', () => {
         const docblock = `
           @returns The number

src/utils/parseJsDoc.js

@@ -28,6 +28,14 @@ type JsDoc = {
 function getType(tag) {
   if (!tag.type) {
     return null;
+  } else if (tag.type.type === 'UnionType') {
+    // union type
+    return {name: 'union', value: tag.type.elements.map(function (element) {
+      return element.name;
+    })};
+  } else if (tag.type.type === 'AllLiteral') {
+    // return {*}
+    return {name: 'mixed'};
   }
   return {name: tag.type.name ? tag.type.name : tag.type.expression.name};
 }