Ensure JxlOptions matches the options jxl() accepts - #4602
Open
ramin-010 wants to merge 1 commit into
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
I found this while comparing the JSDoc with the type definitions for the different format options. JxlOptions was missing AnimationOptions, even though JXL supports animation at runtime, so TypeScript was rejecting things like jxl({ loop: 3 }) and jxl({ delay: [100, 200] }). I added AnimationOptions to JxlOptions and added two type tests for these cases.
I also noticed the effort comment says 3–9, while the runtime check and JSDoc both allow 1–9, so I fixed that as well. Both changes are in the same interface/type mismatch, so I kept them together, but I can split the effort change into a separate PR if preferred.