API reference / @docmentis/udoc-node
@docmentis/udoc-node
Read, render, and process documents programmatically in Node.js.
Classes
| Class | Description |
|---|---|
| UDocNode | The udoc engine in this process: the host's identity, and the compiled engine every session instantiates. Build one per host identity and open as many documents through it as needed — each is a session of its own, on a thread of its own. |
Interfaces
| Interface | Description |
|---|---|
| Entitlements | What a session is entitled to, resolved once as it starts. A feature is enabled two ways: the valid license carries it, or — with no license — the permit grants it. |
| RemoteCheckpointResponse | A server's answer to UDocSession.requestRemoteCheckpoint: the version of the baseline it wrote. |
| UDocNodeOptions | What the engine is told about who is running it, under what license, and which fonts it may draw with beyond a document's own. Every session started through the same UDocNode carries it. |
| UDocSession | A session: one open document, driven on a worker thread of its own, so every call is asynchronous and none blocks the caller's event loop while the engine composes or rasterizes. As in the engine, the session is its document — opening one is the open, closing it is the close. |
Type Aliases
| Type Alias | Description |
|---|---|
| Feature | A feature a session may be entitled to — carried by the license that admitted it, or with none, granted by its permit. |
Functions
| Function | Description |
|---|---|
| isFileFormat | Whether value is a file format's name ("pdf", "pptx", "jpg", …). |
References
ExportFormat
Re-exports ExportFormat
FileFormat
Re-exports FileFormat
PageExportFormat
Re-exports PageExportFormat
SaveStrategy
Re-exports SaveStrategy
UDocError
Re-exports UDocError
UDocErrorCode
Re-exports UDocErrorCode
UDocErrorDetail
Re-exports UDocErrorDetail
UDocType
Re-exports UDocType