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: chapters and cuepoints interface doesnt reflect internal types #977

Merged
merged 2 commits into from
Aug 21, 2024

Conversation

AdamJaggard
Copy link
Contributor

@AdamJaggard AdamJaggard commented Aug 21, 2024

When we released chapters we unified the chapter and cuepoint types under the hood, making both support an optional endTime with cuepoints still supporting the legacy shape using time instead of startTime. Our addChapters and addCuePoints methods on the player don't use these new types though. endTime is currently required by the addChapters method, but shouldn't be, and only the legacy type is required by addCuePoints.

These changes re-use our existing internal types for Chapter and CuePoint for the external interface.

Fixes #947

@AdamJaggard AdamJaggard requested a review from a team as a code owner August 21, 2024 14:02
Copy link

vercel bot commented Aug 21, 2024

@AdamJaggard is attempting to deploy a commit to the Mux Team on Vercel.

A member of the Team first needs to authorize it.

Copy link

vercel bot commented Aug 21, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
elements-demo-create-react-app ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 21, 2024 2:08pm
elements-demo-nextjs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 21, 2024 2:08pm
elements-demo-svelte-kit ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 21, 2024 2:08pm
elements-demo-vanilla ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 21, 2024 2:08pm
elements-demo-vue ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 21, 2024 2:08pm

Copy link
Contributor

@cjpillsbury cjpillsbury left a comment

Choose a reason for hiding this comment

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

Clear. Simple. Better. 😎.

@AdamJaggard AdamJaggard merged commit e3eadec into muxinc:main Aug 21, 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.

Bug: Mismatch between docs, TS types, and behavior for cuepoints and chapters
2 participants