fix: clarify TS Docs for better DX

[taefi]

Fixes #2936

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.57%. Comparing base (ad2c774) to head (fdc7b88).

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #3076   +/-   ##
=======================================
  Coverage   92.57%   92.57%           
=======================================
  Files          85       85           
  Lines        3166     3166           
  Branches      776      776           
=======================================
  Hits         2931     2931           
  Misses        183      183           
  Partials       52       52           

Flag	Coverage Δ
unittests	92.57% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

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