Skip to content

API reference / @docmentis/udoc-server / UDocServerOptions

Interface: UDocServerOptions ​

Properties ​

PropertyDescription
udoc
Pick<UDocNode, "open" | "openRemote">
Opens each document. The embedder builds it, so the license — and whether usage is metered — is theirs to decide.
store
DocumentStore
Where each document is kept between sessions.
maxUploadBytes?
number
The largest document accepted, in bytes. Defaults to 256 MiB.
sessionTimeoutMs?
number
How long a session stays open with no request for it, in milliseconds. Defaults to 5 minutes.
sessionPool?
number
The session pool's size: how many sessions stay open once their requests finish. Past it, the least recently used idle ones close. Defaults to 32.
basePath?
string
The path the routes sit beneath: "/udoc" serves /udoc/documents/…. Defaults to "", the root.