Skip to content

Commit da47933

Browse files
author
joeyklee
committed
refactor: adds jsdocs to bodypix
1 parent 93730b2 commit da47933

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

src/BodyPix/index.js

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,14 @@ class BodyPix {
3030
/**
3131
* Create BodyPix.
3232
* @param {HTMLVideoElement} video - An HTMLVideoElement.
33-
* @param {object} options - An object with options.
34-
* @param {function} callback - A callback to be called when the model is ready.
33+
* @param {{
34+
* multiplier: Number;
35+
* outputStride: Number;
36+
* segmentationThreshold: Number;
37+
* palette: Object;
38+
* returnTensors: Boolean;
39+
* }} options - An object with options.
40+
* @param {Function} callback - A callback to be called when the model is ready.
3541
*/
3642
constructor(video, options, callback) {
3743
this.video = video;

0 commit comments

Comments
 (0)