Interface DocumentEngine

The document surface a WebDocs engine module exposes.

interface DocumentEngine {
    open(): Promise<Document>;
    create(): Promise<Document>;
    import(bytes: Uint8Array, format?: "docx"): Promise<Document>;
}

Index

Methods

open create import

Methods

open

open(): Promise<Document>
Open a new, empty document.

Returns Promise<Document>
- Defined in src/documents/module.ts:30

create

create(): Promise<Document>
Open a new, empty document (a readable alias of DocumentEngine.open).

Returns Promise<Document>
- Defined in src/documents/module.ts:32

import

import(bytes: Uint8Array, format?: "docx"): Promise<Document>
Open a document from encoded bytes. Only "docx" is supported by this build.
Parameters
- bytes: Uint8Array
- Optionalformat: "docx"
Returns Promise<Document>
- Defined in src/documents/module.ts:34