API reference / @docmentis/udoc-server
@docmentis/udoc-server
Self-hosted document server for remote access, rendering, and collaboration.
Classes
| Class | Description |
|---|---|
| DirectoryDocumentStore | A DocumentStore over a directory: one directory per document, named by its id, holding its original, its checkpoints and its edit log. |
Interfaces
| Interface | Description |
|---|---|
| DocumentStore | Where the server keeps each document, by id. |
| KeptDocument | What is kept of one document when it is imported. |
| Original | A document's upload, as it arrived, and the format it was imported as. |
| PackageDescription | What a client opening a package needs to know of it. |
| UDocServer | - |
| UDocServerOptions | - |
Type Aliases
| Type Alias | Description |
|---|---|
| Frontier | A CRDT frontier as the engine writes it: [peer, counter] pairs, each a u64. A peer is random, past what a JS number holds exactly, so each is a bigint. |
Functions
| Function | Description |
|---|---|
| createUDocServer | Build the server over options.store: its routes are the document routes (see documentRoutes), beneath options.basePath. |