Interface Document

interface Document {
    get(): DocumentContentWithId;
    remove(): void;
    update(update: JSONUpdate): void;
}

Index

Methods

get remove update

Methods

get

get(): DocumentContentWithId
Returns DocumentContentWithId
- Defined in src/types/document.ts:15

remove

remove(): void
Returns void
- Defined in src/types/document.ts:24

update

update(update: JSONUpdate): void
This operation is transactional: if it throws, nothing changes.
Parameters
- update: JSONUpdate
Returns void
Throws
Propagates errors thrown by JSONObjectOps.update.
- Defined in src/types/document.ts:22