refactor: adds jsdocs to bodypix

ml5js · Feb 13, 2022 · da47933 · da47933
1 parent 93730b2
commit da47933
Showing 1 changed file with 8 additions and 2 deletions.
diff --git a/src/BodyPix/index.js b/src/BodyPix/index.js
@@ -30,8 +30,14 @@ class BodyPix {
   /**
      * Create BodyPix.
      * @param {HTMLVideoElement} video - An HTMLVideoElement.
-     * @param {object} options - An object with options.
-     * @param {function} callback - A callback to be called when the model is ready.
+     * @param {{
+     *  multiplier: Number;
+     *  outputStride: Number;
+     *  segmentationThreshold: Number;
+     *  palette: Object;
+     *  returnTensors: Boolean;
+     * }} options - An object with options.
+     * @param {Function} callback - A callback to be called when the model is ready.
      */
   constructor(video, options, callback) {
     this.video = video;