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

Merge pull request #9584 from Rob--W/docs-examples-2.0

Browse Source 
Update examples/ documentation for 2.0
This commit is contained in:
Tim van der Meij 2018-03-20 23:20:02 +01:00 committed by GitHub
commit c0b22da02a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/contents/examples/index.md
View File

@ -9,18 +9,21 @@ template: layout.jade
PDF.js heavily relies on the use of [Promises](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise). If promises are new to you, it's recommended you become familiar with them before continuing on.
This tutorial shows how PDF.js can be used as a library in a web browser.
[examples/](https://github.com/mozilla/pdf.js/tree/master/examples) provides more examples, including usage in Node.js (at [examples/node/](https://github.com/mozilla/pdf.js/tree/master/examples/node)).
### Document
The object structure of PDF.js loosely follows the structure of an actual PDF. At the top level there is a document object. From the document, more information and individual pages can be fetched. To get the document:
```js
PDFJS.getDocument('helloworld.pdf')
pdfjsLib.getDocument('helloworld.pdf')
```
Remember though that PDF.js uses promises, so the above will return a promise that is resolved with the document object.
```js
PDFJS.getDocument('helloworld.pdf').then(function(pdf) {
pdfjsLib.getDocument('helloworld.pdf').then(function(pdf) {
// you can now use *pdf* here
});
```