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

Merge pull request #16159 from nmtigor/b-Object_in_api

Browse Source 
Write some {Object} in api.js more precise
This commit is contained in:
Jonas Jenwald 2023-04-01 15:57:46 +02:00 committed by GitHub
commit 8b7e44682c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/display/api.js
View File

@ -1204,7 +1204,8 @@ class PDFDocumentProxy {
* before viewport transform. * before viewport transform.
* @property {Object} [canvasFactory] - The factory instance that will be used * @property {Object} [canvasFactory] - The factory instance that will be used
* when creating canvases. The default value is {new DOMCanvasFactory()}. * when creating canvases. The default value is {new DOMCanvasFactory()}.
* @property {Object | string} [background] - Background to use for the canvas. * @property {CanvasGradient | CanvasPattern | string} [background] - Background
* to use for the canvas.
* Any valid `canvas.fillStyle` can be used: a `DOMString` parsed as CSS * Any valid `canvas.fillStyle` can be used: a `DOMString` parsed as CSS
* <color> value, a `CanvasGradient` object (a linear or radial gradient) or * <color> value, a `CanvasGradient` object (a linear or radial gradient) or
* a `CanvasPattern` object (a repetitive image). The default value is * a `CanvasPattern` object (a repetitive image). The default value is
@ -1930,7 +1931,8 @@ class PDFPageProxy {
} }
/** /**
* @type {Object} Returns page stats, if enabled; returns `null` otherwise. * @type {StatTimer | null} Returns page stats, if enabled; returns `null`
* otherwise.
*/ */
get stats() { get stats() {
return this._stats; return this._stats;
@ -1970,7 +1972,7 @@ class LoopbackPort {
/** /**
* @typedef {Object} PDFWorkerParameters * @typedef {Object} PDFWorkerParameters
* @property {string} [name] - The name of the worker. * @property {string} [name] - The name of the worker.
* @property {Object} [port] - The `workerPort` object. * @property {Worker} [port] - The `workerPort` object.
* @property {number} [verbosity] - Controls the logging level; * @property {number} [verbosity] - Controls the logging level;
* the constants from {@link VerbosityLevel} should be used. * the constants from {@link VerbosityLevel} should be used.
*/ */