[api-minor] Expose response headers, when available, in PDFDocumentLoadingTask
#18908
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 is a feature that's been requested a few times over the years, see e.g. issue #14630, #16341, and #18792.
Note that by placing the
getResponseHeaders
method inPDFDocumentLoadingTask
it's possible to access the response headers even if loading failed, e.g. withMissingPDFException
, which wouldn't have been possible if the method was placed elsewhere (e.g. inPDFDocumentProxy
).Given the following JSDoc comment, this also seems generally reasonable:
pdf.js/src/display/api.js
Lines 570 to 575 in 689ffda
Considering that this functionality isn't relevant in e.g. the Firefox PDF Viewer, pre-processor statements are being used to limit the code-size impact of the implementation to GENERIC-builds as much as possible.
Please note: This will further increase the maintenance/support burden of the general PDF.js library, for a feature that's completely unused within the project itself.
Hence, if you'd like to see this patch landed, please contact me privately to discuss sponsoring this work (email address can be found in my GitHub profile).