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.

Sign up for GitHub

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

Jump to bottom

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

Merged
merged 2 commits into from
May 23, 2024
Merged

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

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.

video.js/src/js/media-error.js

Line 81 in f05769d

* @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

@codecov Codecov
Copy link

codecov bot commented May 17, 2024 •
edited
Loading

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.

wseymour15
wseymour15 approved these changes May 21, 2024
View reviewed changes
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
@kerasus kerasus mentioned this pull request Jun 21, 2024
Open
@Bitti09 Bitti09 mentioned this pull request Jun 21, 2024
Closed
@kerasus kerasus mentioned this pull request Jun 28, 2024
Open
@apiiro-snyk apiiro-snyk mentioned this pull request Jul 2, 2024
Open
@kerasus kerasus mentioned this pull request Jul 4, 2024
Open
@ChaosEngine ChaosEngine mentioned this pull request Jul 9, 2024
Open
@kerasus kerasus mentioned this pull request Jul 16, 2024
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@wseymour15 wseymour15 wseymour15 approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@mister-ben @wseymour15