Skip to content

Latest commit

 

History

History
173 lines (92 loc) · 3.11 KB

DocxOptions.md

File metadata and controls

173 lines (92 loc) · 3.11 KB

Interface: DocxOptions

Hierarchy

  • Pick<IPropertiesOptions, "title" | "subject" | "creator" | "keywords" | "description" | "lastModifiedBy" | "revision" | "styles" | "background">

    DocxOptions

Table of contents

Properties

Properties

output

Optional output: "buffer" | "blob"

Set output type of VFile.result. buffer is Promise<Buffer>. blob is Promise<Blob>.

Defined in

src/transformer.ts:137


imageResolver

Optional imageResolver: ImageResolver

You must set if your markdown includes images. See example for browser and Node.js.

Defined in

src/transformer.ts:141


title

Optional Readonly title: string

Inherited from

Pick.title

Defined in

node_modules/docx/build/file/core-properties/properties.d.ts:12


subject

Optional Readonly subject: string

Inherited from

Pick.subject

Defined in

node_modules/docx/build/file/core-properties/properties.d.ts:13


creator

Optional Readonly creator: string

Inherited from

Pick.creator

Defined in

node_modules/docx/build/file/core-properties/properties.d.ts:14


keywords

Optional Readonly keywords: string

Inherited from

Pick.keywords

Defined in

node_modules/docx/build/file/core-properties/properties.d.ts:15


description

Optional Readonly description: string

Inherited from

Pick.description

Defined in

node_modules/docx/build/file/core-properties/properties.d.ts:16


lastModifiedBy

Optional Readonly lastModifiedBy: string

Inherited from

Pick.lastModifiedBy

Defined in

node_modules/docx/build/file/core-properties/properties.d.ts:17


revision

Optional Readonly revision: number

Inherited from

Pick.revision

Defined in

node_modules/docx/build/file/core-properties/properties.d.ts:18


styles

Optional Readonly styles: IStylesOptions

Inherited from

Pick.styles

Defined in

node_modules/docx/build/file/core-properties/properties.d.ts:20


background

Optional Readonly background: IDocumentBackgroundOptions

Inherited from

Pick.background

Defined in

node_modules/docx/build/file/core-properties/properties.d.ts:28