cpdf-source/javascriptsplits/c00.tex

43 lines
960 B
TeX

// CHAPTER -1: Introduction
/**
Use
---
cpdf.js can be used from both node and the browser.
For development server-side with node: `cpdf.js` (minified version
`cpdf.min.js`) Load with `const cpdf = require('cpdf.js')` if installed in npm,
or `const cpdf = require('./cpdf.js')` to load from current directory.
For development client-side with the browser : `cpdf.browser.js` (minified
version for deployment : `cpdf.browser.min.js`). Load with `<script
src="cpdf.browser.js"></script>` or similar.
Data types
----------
Arguments are numbers, strings, or arrays (of type UInt8Array for data). Page
ranges are represented by arrays of numbers.
Memory Management
-----------------
A PDF p must be explicitly deallocated with deletePdf(p).
Errors
------
Any function may raise an exception, containing a string describing the problem.
Concurrency
-----------
cpdf.js is synchronous and non-re-entrant. In the browser, best used in a worker.
**/