Skip to content

API reference / Common / LocalCollaborationServiceOptions

Interface: LocalCollaborationServiceOptions ​

Options for startLocalCollaborationService: the license the service's session is started under, and where to find the WASM — as a client's are — and the name of the document's file.

Properties ​

PropertyDescription
license?
string
Commercial license key. Default none: free usage, which is metered and needs the engine to reach the permit service.
hideAttribution?
boolean
Ask for the "Powered by docMentis" decal not to be painted. Honored only with a license. Default false.
disableTelemetry?
boolean
Ask for usage not to be reported. Honored only with a license. Default false.
wasm?
WasmLocateOptions
Where to load the WASM from, for a host that serves it itself. Default the copy bundled with @docmentis/udoc-wasm, then jsDelivr's.
filename?
string
The document's file name, whose extension names a CSV's, a TSV's or a PSV's format, which has no signature. Default none: the format is detected from the bytes.