refactor: updates jsdoc types

Author: joeyklee

src/BodyPix/index.js

@@ -11,6 +11,7 @@
  * Ported and integrated from all the hard work by: https://github.com/tensorflow/tfjs-models/tree/master/body-pix
  */
 
+// @ts-check
 import * as tf from '@tensorflow/tfjs';
 import * as bp from '@tensorflow-models/body-pix';
 import callCallback from '../utils/callcallback';
@@ -50,7 +51,7 @@ class BodyPix {
 
   /**
      * Load the model and set it to this.model
-     * @return {this} the BodyPix model.
+     * @return {Promise<Object>} the BodyPix model.
      */
   async loadModel() {
     this.model = await bp.load(this.config.multiplier);
@@ -60,7 +61,7 @@ class BodyPix {
 
   /**
      * Returns an rgb array
-     * @param {Object} a p5.Color obj
+     * @param {Object} p5ColorObj - a p5.Color obj
      * @return {Array} an [r,g,b] array
      */
   /* eslint class-methods-use-this: "off" */
@@ -83,7 +84,7 @@ class BodyPix {
 
   /**
      * Returns a bodyPartsSpec object 
-     * @param {Array} an array of [r,g,b] colors
+     * @param {Array} colorOptions - an array of [r,g,b] colors
      * @return {object} an object with the bodyParts by color and id
      */
   /* eslint class-methods-use-this: "off" */
@@ -107,11 +108,11 @@ class BodyPix {
 
   /**
      * Segments the image with partSegmentation, return result object
-     * @param {HTMLImageElement | HTMLCanvasElement | object | function | number} imageToSegment - 
+     * @param {HTMLImageElement | HTMLCanvasElement | object | function | number} imgToSegment - 
      *    takes any of the following params
      * @param {object} segmentationOptions - config params for the segmentation
      *    includes outputStride, segmentationThreshold
-     * @return {Object} a result object with image, raw, bodyParts
+     * @return {Promise<Object>} a result object with image, raw, bodyParts
      */
   async segmentWithPartsInternal(imgToSegment, segmentationOptions) {
     // estimatePartSegmentation
@@ -220,7 +221,7 @@ class BodyPix {
      * @param {object} configOrCallback - config params for the segmentation
      *    includes palette, outputStride, segmentationThreshold
      * @param {function} cb - a callback function that handles the results of the function.
-     * @return {function} a promise or the results of a given callback, cb.
+     * @return {Promise<Object>} a promise or the results of a given callback, cb.
      */
   async segmentWithParts(optionsOrCallback, configOrCallback, cb) {
     let imgToSegment = this.video;
@@ -268,11 +269,11 @@ class BodyPix {
 
   /**
      * Segments the image with personSegmentation, return result object
-     * @param {HTMLImageElement | HTMLCanvasElement | object | function | number} imageToSegment - 
+     * @param {HTMLImageElement | HTMLCanvasElement | object | function | number} imgToSegment - 
      *    takes any of the following params
      * @param {object} segmentationOptions - config params for the segmentation
      *    includes outputStride, segmentationThreshold
-     * @return {Object} a result object with maskBackground, maskPerson, raw
+     * @return {Promise<Object>} a result object with maskBackground, maskPerson, raw
      */
   async segmentInternal(imgToSegment, segmentationOptions) {
 
@@ -372,12 +373,12 @@ class BodyPix {
 
   /**
      * Segments the image with personSegmentation
-     * @param {HTMLImageElement | HTMLCanvasElement | object | function | number} optionsOrCallback - 
+     * @param {HTMLVideoElement | HTMLImageElement | HTMLCanvasElement | object | function | number} optionsOrCallback - 
      *    takes any of the following params
      * @param {object} configOrCallback - config params for the segmentation
      *    includes outputStride, segmentationThreshold
      * @param {function} cb - a callback function that handles the results of the function.
-     * @return {function} a promise or the results of a given callback, cb.
+     * @return {Promise<Object>} a promise or the results of a given callback, cb.
      */
   async segment(optionsOrCallback, configOrCallback, cb) {
     let imgToSegment = this.video;
@@ -424,6 +425,13 @@ class BodyPix {
 
 }
 
+/**
+ * 
+ * @param {Object | Function} videoOrOptionsOrCallback 
+ * @param {Object | Function} optionsOrCallback 
+ * @param {Function} cb 
+ * @returns {Promise<Object> | Function}
+ */
 const bodyPix = (videoOrOptionsOrCallback, optionsOrCallback, cb) => {
   let video;
   let options = {};