Sakurai/pdf.js
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[api-minor] Deprecate calling getDocument directly with a PDFDataRangeTransport-instance

Browse Source 
In general it's recommended to pass a *parameter object* when calling the `getDocument`-function in the API, since that's the only way to provide additional options, and the fact that it also accepts a URL or TypedArray directly is now mostly for backwards compatibility reasons.
However, the `getDocument`-function also accepts a direct `PDFDataRangeTransport`-instance which just seems unnecessary.

*Please note:* The `PDFDataRangeTransport`-implementation was added specifically for the *built-in* Firefox PDF Viewer, however it's most likely not commonly used by any third-party (given that it requires manual PDF-data loading).
Furthermore, the default-viewer always provides a *parameter object* when calling the `getDocument`-function and it's thus completely unaffected by these changes.
This commit is contained in:
Jonas Jenwald 2023-01-19 12:40:09 +01:00
parent c629a85a5c
commit 7976fc7851
2 changed files with 11 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
src/display/api.js
View File

@ -233,8 +233,7 @@ if (typeof PDFJSDev === "undefined" || !PDFJSDev.test("PRODUCTION")) {
*/
/**
* @typedef { string | URL | TypedArray | ArrayBuffer |
* PDFDataRangeTransport | DocumentInitParameters
* @typedef { string | URL | TypedArray | ArrayBuffer | DocumentInitParameters
* } GetDocumentParameters
*/
@ -258,7 +257,14 @@ function getDocument(src) {
source = { url: src };
} else if (isArrayBuffer(src)) {
source = { data: src };
} else if (src instanceof PDFDataRangeTransport) {
} else if (
(typeof PDFJSDev === "undefined" || PDFJSDev.test("GENERIC")) &&
src instanceof PDFDataRangeTransport
) {
deprecated(
"`PDFDataRangeTransport`-instance, " +
"please use a parameter object with `range`-property instead."
);
source = { range: src };
} else {
if (typeof src !== "object") {

4
test/unit/api_spec.js
View File

@ -3265,7 +3265,7 @@ Caron Broadcasting, Inc., an Ohio corporation (“Lessee”).`)
});
};
const loadingTask = getDocument(transport);
const loadingTask = getDocument({ range: transport });
const pdfDocument = await loadingTask.promise;
expect(pdfDocument.numPages).toEqual(14);
@ -3310,7 +3310,7 @@ Caron Broadcasting, Inc., an Ohio corporation (“Lessee”).`)
});
};
const loadingTask = getDocument(transport);
const loadingTask = getDocument({ range: transport });
const pdfDocument = await loadingTask.promise;
expect(pdfDocument.numPages).toEqual(14);