mirror of
https://github.com/mozilla/pdf.js.git
synced 2025-04-22 16:18:08 +02:00
Fix Viewer API definitions and include in CI
The Viewer API definitions do not compile because of missing imports and anonymous objects are typed as `Object`. These issues were not caught during CI because the test project was not compiling anything from the Viewer API. As an example of the first problem: ``` /** * @implements MyInterface */ export class MyClass { ... } ``` will generate a broken definition that doesn’t import MyInterface: ``` /** * @implements MyInterface */ export class MyClass implements MyInterface { ... } ``` This can be fixed by adding a typedef jsdoc to specify the import: ``` /** @typedef {import("./otherFile").MyInterface} MyInterface */ ``` See https://github.com/jsdoc/jsdoc/issues/1537 and https://github.com/microsoft/TypeScript/issues/22160 for more details. As an example of the second problem: ``` /** * Gets the size of the specified page, converted from PDF units to inches. * @param {Object} An Object containing the properties: {Array} `view`, * {number} `userUnit`, and {number} `rotate`. */ function getPageSizeInches({ view, userUnit, rotate }) { ... } ``` generates the broken definition: ``` function getPageSizeInches({ view, userUnit, rotate }: Object) { ... } ``` The jsdoc should specify the type of each nested property: ``` /** * Gets the size of the specified page, converted from PDF units to inches. * @param {Object} options An object containing the properties: {Array} `view`, * {number} `userUnit`, and {number} `rotate`. * @param {number[]} options.view * @param {number} options.userUnit * @param {number} options.rotate */ ```
This commit is contained in:
parent
ada283cc35
commit
c08b4ea30d
15 changed files with 47 additions and 11 deletions
|
@ -1,9 +1,12 @@
|
|||
import { getDocument } from "pdfjs-dist";
|
||||
import { EventBus } from "pdfjs-dist/web/pdf_viewer.component";
|
||||
|
||||
class MainTest {
|
||||
eventBus: EventBus;
|
||||
task: ReturnType<typeof getDocument> | undefined;
|
||||
|
||||
constructor(public file: string) {
|
||||
this.eventBus = new EventBus({});
|
||||
}
|
||||
|
||||
loadPdf() {
|
||||
|
|
|
@ -17,7 +17,7 @@
|
|||
],
|
||||
"paths": {
|
||||
"pdfjs-dist": ["../../build/typestest"],
|
||||
"pdfjs-dist/*": ["../../build/typestest/build/*"]
|
||||
"pdfjs-dist/*": ["../../build/typestest/types/*"]
|
||||
}
|
||||
},
|
||||
"files": [
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue