Interface PutDocumentOptions

options for uploading a full document archive

interface PutDocumentOptions {
    id?: string;
    parent?: string;
    refresh?: boolean;
    visibleName?: string;
}

Properties

id?: string

reuse this document id instead of generating a fresh one

By default a new uuid is generated so re-uploading an archive to the same account doesn't collide with the original. Pass an id to restore in place.

parent?: string

the parent to place the document under, overriding the archived value

refresh?: boolean

if true, refresh the root hash before uploading

visibleName?: string

the visible name to use, overriding the archived value