Generate Typescript from JSDOCs

.eslintrc.json

@@ -9,8 +9,8 @@
     "es6": true
   },
   "parser": "babel-eslint",
-  "globals": { 
-    "wx": true 
+  "globals": {
+    "wx": true
   },
   "plugins": [
     "flowtype",
@@ -50,7 +50,8 @@
       {
         "definedTags": [
           "flow",
-          "flow-weak"
+          "flow-weak",
+          "template"
         ]
       }
     ],
@@ -61,7 +62,14 @@
           "AuthProvider",
           "AsyncStorage",
           "LocalDatastoreController",
-          "Parse"
+          "Parse",
+          "ReturnType",
+          "Params",
+          "this",
+          "Attributes",
+          "R",
+          "T",
+          "K"
         ]
       }
     ]

.github/workflows/ci.yml

@@ -19,7 +19,7 @@ jobs:
   build:
     runs-on: ubuntu-18.04
     timeout-minutes: 30
-    env:      
+    env:
       MONGODB_VERSION: 3.6.9
     steps:
     - uses: actions/checkout@v2
@@ -38,6 +38,8 @@ jobs:
     - run: npm install -g mongodb-runner
     - run: mongodb-runner start
     - run: npm run lint
+    - run: npm run types
+    - run: npm run test:types
     - run: npm test -- --maxWorkers=4
     - run: npm run integration
       env:

integration/test/clear.js

@@ -5,7 +5,7 @@ const Parse = require('../../node');
  * Calls /clear route in integration/test/server.js
  *
  * @param {boolean} fast set to true if it's ok to just drop objects and not indexes.
- * @returns {Promise} A promise that is resolved when database is deleted.
+ * @returns {Promise<any>} A promise that is resolved when database is deleted.
  */
 module.exports = function (fast = true) {
   return Parse._ajax('GET', `http://localhost:1337/clear/${fast}`, '');

jsdoc-conf.json

@@ -1,5 +1,5 @@
 {
-  "plugins": ["node_modules/jsdoc-babel", "plugins/markdown"],
+  "plugins": ["node_modules/jsdoc-babel", "plugins/markdown", "jsdoc-plugin-intersection"],
   "babel": {
       "plugins": ["@babel/plugin-transform-flow-comments"]
   },

jsdoc-ts-conf.json

@@ -0,0 +1,24 @@
+{
+  "plugins": ["node_modules/jsdoc-babel", "plugins/markdown", "./node_modules/tsd-jsdoc/dist/plugin", "./types/plugin.js"],
+  "babel": {
+      "plugins": ["@babel/plugin-transform-flow-strip-types"]
+  },
+  "source": {
+    "include":  ["./README.md"],
+    "excludePattern": "(^|\\/|\\\\)_"
+  },
+  "templates": {
+    "default": {
+      "outputSourceFiles": false,
+      "showInheritedInNav": false,
+      "useLongnameInNav": true
+    },
+    "cleverLinks": true,
+    "monospaceLinks": false
+  },
+  "opts": {
+    "template": "./node_modules/tsd-jsdoc/dist",
+    "recurse": true,
+    "destination": "types"
+  }
+}