README.md

TypeScript PDF Viewer Sample (PDF.js Express)

PDF.js Express is a powerful JavaScript-based PDF Library that leverages PDF.js and adds additional features such as annotations, form support, and digitial signatures. It provides a slick out-of-the-box responsive UI that interacts with the core library to view, annotate and manipulate PDFs that can be embedded into any web project.

This repo is specifically designed for any users interested in integrating WebViewer into a TypeScript project. Express has a comprehensive definition file ready for use by just adding a reference to the definition file.

Initial setup

Before you begin, make sure your development environment includes Node.js.

Install

git clone https://github.com/pdfjs-express/pdfjs-express-typescript-sample.git
cd pdfjs-express-typescript-sample
npm install

Run

Setup the TypeScript compiler to watch for changes and recompile the source file:

npm run watch

Open a different shell service and run:

npm start

Express APIs

Most classes and functions are well documented in the TypeScript definition file. See API documentation.

License

See license.