DocAuthDocument

DocAuthDocument:

{
  saveDocument(): Promise<object>;
  saveDocumentJSONString(): Promise<string>;
  exportPDF(options?: ExportPDFOptions): Promise<ArrayBuffer>;
  exportDOCX(options?: ExportDOCXOptions): Promise<ArrayBuffer>;
  export(config: ExportConfig): Promise<ArrayBuffer>;
  transaction(callback: TransactionCallback<T>): Promise<T>;
  docAuthSystem(): DocAuthSystem;
}

A document instance. Holds the content and provides methods for saving, exporting to PDF/DOCX, and more.

Create documents via DocAuthEditor and/or DocAuthSystem.

Methods

saveDocument()

saveDocument(): Promise<object>

Returns the current document in the Document Authoring format as a JavaScript object. This object can be safely persisted.

Returns

Promise<object>

See

DocJSON guide

---

saveDocumentJSONString()

saveDocumentJSONString(): Promise<string>

Returns the current document in the Document Authoring format as a JSON string. This string can be safely persisted.

Returns

Promise<string>

See

• DocAuthDocument.saveDocument
• DocJSON guide

---

exportPDF()

exportPDF(options?): Promise<ArrayBuffer>

Exports a snapshot of the current document as a PDF file.

Parameters

options?

ExportPDFOptions

Returns

Promise<ArrayBuffer>

See

PDF export guide

---

exportDOCX()

exportDOCX(options?): Promise<ArrayBuffer>

Exports a snapshot of the current document as a DOCX file.

Parameters

options?

ExportDOCXOptions

Returns

Promise<ArrayBuffer>

See

DOCX export guide

---

export()

NEW

export(config): Promise<ArrayBuffer>

Exports a snapshot of the current document in the specified format.

Parameters

config

ExportConfig

Returns

Promise<ArrayBuffer>

See

ExportConfig

---

transaction()

>= v1.10.0

transaction<T>(callback): Promise<T>

Executes a transaction to programmatically read or modify the document.

Type Parameters

T

T = void

Parameters

callback

TransactionCallback<T>

A TransactionCallback function that receives a draft document

Returns

Promise<T>

A Promise that resolves to the result value from the callback

Remarks

Provides programmatic access to the document structure through a draft document that can be read and modified. Changes are atomic and isolated until the transaction commits.

The callback executes after all pending transactions and input have been processed. While the callback runs, document access is blocked, preventing any UI interactions until the transaction completes.

Example

await doc.transaction(async ({ draft }) => {
  const section = draft.body().sections()[0];
  const para = section.content().addParagraph();
  para.asTextView().setText('Hello, World!');
  return { commit: true };
});

See

• TransactionCallback for the callback function signature
• TransactionResult for return value options
• Programmatic for the full programmatic API namespace

---

docAuthSystem()

docAuthSystem(): DocAuthSystem

The DocAuthSystem this document is bound to.

Returns

DocAuthSystem