Documentation / Install guides
Install TypeScript
The Node binding with a typed surface and a TS example.
1. Get the package
The download is public and needs no key — unlicensed output carries an
evaluation watermark and nothing else is restricted. The package file is
typescript.zip.
2. Check your platform
Two separate facts per platform: whether a licence key for this package covers it, and whether the download ships an engine binary for it.
| Platform | Licence covers it | Binary in the download |
|---|---|---|
win-x64 |
Yes | Yes |
linux-x64 |
Yes | Yes |
macos |
Yes | Yes |
3. Install
shell
npm install lumaspdf
# or: unzip typescript.zip and npm install ./typescript
4. Licence it
A licence is one key string, set once at startup. Buying one and installing it is covered by how licensing works; until then the engine runs fully functional with an evaluation watermark.
5. Your first PDF
The smallest complete program: create, write, close.
typescript
import { createPdf, append, writeFText, endPage, closeFile } from 'lumaspdf';
const pdf = createPdf('hello.pdf');
append(pdf);
writeFText(pdf, 0, 'Hello from LumasPDF');
endPage(pdf);
closeFile(pdf);
Where next
- The full quick start Step by step, from unzip to a rendered page.
- Runnable examples Complete programs, each verified against a named release.
- The TypeScript package page Editions, pricing, and everything in the download.
- API reference Every exported function, with declarations.