Pdf.js: Import pdf.js with typescript

Created on 12 Feb 2019 · 8Comments · Source: mozilla/pdf.js

Attach (recommended) or Link to PDF file here:

Configuration:

Web browser and its version: NODE 10
Operating system and its version: LINUX/DOCKER
PDF.js version: pdfjs-dist 2.2.2
Is a browser extension: NO

Steps to reproduce the problem:

Install pdfjs-dist with: npm install pdfjs-dist --save
Install @types/pdfjs-dist with: npm install @types/pdfjs-dist --save-dev
Import pdfjs-dist in a *.ts file: import { PDFJS } from 'pdfjs-dist';
Use getDocument from PDFJS: PDFJS.getDocument('my.pdf')
execute the code and see the error: _PDFJS is not defined_

What is the expected behavior?
PDFJS works on typescript

What went wrong?
PDFJS can't export correctly the lib on typescript

Link to a viewer:
not disponible

Work around:
Import PDFJS in this way

import { PDFJSStatic } from 'pdfjs-dist'; 
const PDFJS: PDFJSStatic = require('pdfjs-dist');

Source

cesco69

Most helpful comment

Does pdfjs provide it's own Typescript types somewhere else?

Bluejanis on 11 Jul 2019

👍26

All 8 comments

2\. Install **@types/pdfjs-dist** with: `npm install @types/pdfjs-dist --save-dev`

Most likely, those types haven't been updated to handle PDF.js versions above 2.0.
However please note that that's a different library, which is not maintained here, hence this issue is unfortunately out-of-scope/invalid here.

Snuffleupagus on 12 Feb 2019

👍1

@Snuffleupagus @timvandermeij Could you please reopen? @types/pdfjs-dist is totally off for version >= 2 and the Github repository does not have any issue tracker.

MickL on 20 May 2019

Install @types/pdfjs-dist with: npm install @types/pdfjs-dist --save-dev

As mentioned in https://github.com/mozilla/pdf.js/issues/10547#issuecomment-462675381, those are not in any way affiliated with Mozilla or the PDF.js project.

@types/pdfjs-dist

Again this is not related to https://github.com/mozilla/pdfjs-dist, but most likely you're actually referring to these ones: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/pdfjs-dist

Snuffleupagus on 20 May 2019

@types/pdfjs-dist should be maintained by mozilla/pdfjs-dist and/or mozilla/pdf.js contributors.

Only this contributors know the code and the functions and can write the required interfaces.

MickL on 20 May 2019

👍8

There are already open issues and even PRs for this, but so far the real demand for this is low and the PRs have not really been updated. If you think this is in fact important, please consider updating the existing PRs (such as #10575 which seems like a good approach since it attempts to generate it from the code itself) so they can be brought in a mergeable state.