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

Preload parameter wrong type #8282

Closed
alfonsograziano opened this issue May 18, 2023 · 2 comments
Closed

Preload parameter wrong type #8282

alfonsograziano opened this issue May 18, 2023 · 2 comments

Comments

@alfonsograziano
Copy link

Description

Ehy everyone, I'm using the preload option from the VideoPlayerOptions.
In the Typescript type imported from video.js/dist/types/player it looks like the preload function accepts a boolean.

Also in the code doc there is a boolean value param. This looks wrong to me, since in the documentation this option is a string.

Can this be an issue or is intended to be true/false? If so, maybe it is worth to update the documentation

Reduced test case

* @param {boolean} [value]

Steps to reproduce

  1. import type VideoJsPlayerOptions from 'video.js/dist/types/player';
  2. Check the preload option required type
  3. Should be a function which takes a string, but is a function which takes a boolean

Errors

No response

What version of Video.js are you using?

8.0.3

Video.js plugins used.

No response

What browser(s) including version(s) does this occur with?

Typescript issue

What OS(es) and version(s) does this occur with?

Typescript issue

@alfonsograziano alfonsograziano added the needs: triage This issue needs to be reviewed label May 18, 2023
@welcome
Copy link

welcome bot commented May 18, 2023

👋 Thanks for opening your first issue here! 👋

If you're reporting a 🐞 bug, please make sure you include steps to reproduce it. We get a lot of issues on this repo, so please be patient and we will get back to you as soon as we can.
To help make it easier for us to investigate your issue, please follow the contributing guidelines.

@mister-ben
Copy link
Contributor

Thansk. Addressed in #8277

@mister-ben mister-ben removed the needs: triage This issue needs to be reviewed label May 18, 2023
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 3, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants