Make downloadManager optional in JSDoc types #17038
Merged
Conversation
This file contains 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
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.
This pull request addresses an issue where the downloadManager parameter was incorrectly marked as required in the JSDoc types for AnnotationLayerParameters and AnnotationLayerBuilderOptions. The change aligns the parameter with similar optional parameters in the codebase for better consistency.
Details:
In pdf.js/src/display/annotation_layer.js, I updated the JSDoc comments for AnnotationLayerParameters to make downloadManager optional using square brackets.
In pdf.js/web/annotation_layer_builder.js, I did the same for the JSDoc comments for AnnotationLayerBuilderOptions.
Additionally, in pdf.js/web/text_layer_builder.js, I marked the downloadManager parameter as optional in the JSDoc comment to maintain consistency with other optional parameters.
Expected Behavior:
The downloadManager parameter should be considered optional in the JSDoc types.
What Went Wrong:
Previously, downloadManager was incorrectly marked as a required parameter.
Configuration:
PDF.js version: 2.11.174
Browser extension: No
This change resolves the issue where downloadManager was mistakenly marked as required, making it optional in the JSDoc types, improving codebase consistency.
Closes: #17029