adding in jsdoc

[jaredwray]

Please check if the PR fulfills these requirements

• Followed the Contributing guidelines.
• Tests for the changes have been added (for bug fixes/features) with 100% code coverage.
• Docs have been added / updated (for bug fixes / features)

What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)
adding in jsdoc

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (094b605) to head (6b0539f).
Report is 3 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff            @@
##              main       #18   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            2         2           
  Lines          162       164    +2     
  Branches        49        49           
=========================================
+ Hits           162       164    +2     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.