mirrors/pdf.js
1
0
Fork 0
mirror of https://github.com/mozilla/pdf.js.git synced 2025-04-22 16:18:08 +02:00
Code Activity

Merge pull request #19331 from Snuffleupagus/api-Factory-JSDoc

Browse source 
Simplify the JSDocs for the various `getDocument` Factory-parameters
This commit is contained in:
Tim van der Meij 2025-01-18 13:38:29 +01:00 • committed by GitHub
commit 6d12d2924f
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 8 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

18
src/display/api.js
View file

@ -145,9 +145,8 @@ const DefaultWasmFactory =
* @property {boolean} [cMapPacked] - Specifies if the Adobe CMaps are binary
* packed or not. The default value is `true`.
* @property {Object} [CMapReaderFactory] - The factory that will be used when
* reading built-in CMap files. Providing a custom factory is useful for
* environments without Fetch API or `XMLHttpRequest` support, such as
* Node.js. The default value is {DOMCMapReaderFactory}.
* reading built-in CMap files.
* The default value is {DOMCMapReaderFactory}.
* @property {boolean} [useSystemFonts] - When `true`, fonts that aren't
* embedded in the PDF document will fallback to a system font.
* The default value is `true` in web environments and `false` in Node.js;
@ -156,18 +155,17 @@ const DefaultWasmFactory =
* @property {string} [standardFontDataUrl] - The URL where the standard font
* files are located. Include the trailing slash.
* @property {Object} [StandardFontDataFactory] - The factory that will be used
* when reading the standard font files. Providing a custom factory is useful
* for environments without Fetch API or `XMLHttpRequest` support, such as
* Node.js. The default value is {DOMStandardFontDataFactory}.
* when reading the standard font files.
* The default value is {DOMStandardFontDataFactory}.
* @property {string} [wasmUrl] - The URL where the wasm files are located.
* Include the trailing slash.
* @property {Object} [WasmFactory] - The factory that will be used
* when reading the wasm files. Providing a custom factory is useful
* for environments without Fetch API or `XMLHttpRequest` support, such as
* Node.js. The default value is {DOMWasmFactory}.
* when reading the wasm files.
* The default value is {DOMWasmFactory}.
* @property {boolean} [useWorkerFetch] - Enable using the Fetch API in the
* worker-thread when reading CMap and standard font files. When `true`,
* the `CMapReaderFactory` and `StandardFontDataFactory` options are ignored.
* the `CMapReaderFactory`, `StandardFontDataFactory`, and `WasmFactory`
* options are ignored.
* The default value is `true` in web environments and `false` in Node.js.
* @property {boolean} [stopAtErrors] - Reject certain promises, e.g.
* `getOperatorList`, `getTextContent`, and `RenderTask`, when the associated