CLI: Prefer @tstype over @type when generating typedefs (tsd-jsdoc)

protobufjs · Apr 12, 2017 · b355115 · b355115
1 parent 6c37dbd
commit b355115
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 10 deletions.
diff --git a/cli/lib/tsd-jsdoc/publish.js b/cli/lib/tsd-jsdoc/publish.js
@@ -549,16 +549,20 @@ function handleTypeDef(element, parent) {
         if (element.templates && element.templates.length)
             write("<", element.templates.join(", "), ">");
         write(" = ");
-        var type = getTypeOf(element);
-        if (element.type && element.type.names.length === 1 && element.type.names[0] === "function")
-            writeFunctionSignature(element, false, true);
-        else if (type === "object") {
-            if (element.properties && element.properties.length)
-                writeInterfaceBody(element);
-            else
-                write("{}");
-        } else
-            write(type);
+        if (element.tsType)
+            write(element.tsType);
+        else {
+            var type = getTypeOf(element);
+            if (element.type && element.type.names.length === 1 && element.type.names[0] === "function")
+                writeFunctionSignature(element, false, true);
+            else if (type === "object") {
+                if (element.properties && element.properties.length)
+                    writeInterfaceBody(element);
+                else
+                    write("{}");
+            } else
+                write(type);
+        }
         writeln(";");
     }
 }
diff --git a/src/typescript.jsdoc b/src/typescript.jsdoc
@@ -2,12 +2,14 @@
  * Constructor type.
  * @typedef Constructor
  * @template T extends object
+ * @type {Function}
  * @tstype { new(...params: any[]): T }
  */
 
 /**
  * Properties type.
  * @typedef Properties
  * @template T extends object
+ * @type {Object.<string,*>}
  * @tstype { [P in keyof T]?: T[P] } & { [key: string]: any }
  */