c08b4ea30d
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
*/
```
24 lines
662 B
TypeScript
24 lines
662 B
TypeScript
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() {
|
|
this.task = getDocument("file://" + this.file);
|
|
return this.task.promise;
|
|
}
|
|
}
|
|
|
|
// This is actually never called, as the test only consists in compiling the file.
|
|
// The compilation will crawl through all files and make sure that the types are consistent.
|
|
const mt = new MainTest("../pdfs/basicapi.pdf");
|
|
mt.loadPdf().then(() => {
|
|
console.log("loaded");
|
|
});
|