Skip to content

API reference / Common / OpenOptions

Interface: OpenOptions ​

Options for UDocBase.open. Every field is optional; each says its default.

Properties ​

PropertyDescription
format?
FileFormat
The bytes' format, for bytes detection gets wrong: given, it skips detection outright. Default detected — a CSV, a TSV or a PSV, which has no signature, by the file's name — and a .udoc zip opens as a package.
filename?
string
The file's name — what UDocBase.download names the saved document. Default a File's own name, or a URL's last path segment, else document.<format>.
delimiter?
string
The character a CSV's fields are split by, ";", `"
password?
string
The password a protected document opens with, for a host that holds it: tried first, and the user is asked only when it doesn't open the document. Default none — the user is asked.