Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(docs): Add workaround for ErrorMetadata typedef #8737

Merged
merged 2 commits into from
May 23, 2024

Conversation

mister-ben
Copy link
Contributor

Description

This typedef uses typescript syntax which jsdoc itself doesn't understand. That causes npm docs:api to exist with an error code, so docs.videojs.com doesn't update on Netlify.

* @typedef {{errorType: string, [key: string]: any}} ErrorMetadata

This adds a hack as a jsdoc plugin to replace the typedef with valid albeit less accurate jsdoc.

Requirements Checklist

  • Feature implemented / Bug fixed
  • If necessary, more likely in a feature request than a bug fix
    • Change has been verified in an actual browser (Chrome, Firefox, IE)
    • Unit Tests updated or fixed
    • Docs/guides updated
    • Example created (starter template on JSBin)
  • Reviewed by Two Core Contributors

Copy link

codecov bot commented May 17, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 83.15%. Comparing base (978731e) to head (94af9a0).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #8737   +/-   ##
=======================================
  Coverage   83.15%   83.15%           
=======================================
  Files         120      120           
  Lines        7995     7995           
  Branches     1924     1924           
=======================================
  Hits         6648     6648           
  Misses       1347     1347           

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

Copy link
Contributor

@wseymour15 wseymour15 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me!

@mister-ben mister-ben merged commit 4de09e4 into videojs:main May 23, 2024
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants