docx
    Preparing search index...

    Class File

    Represents a Word document file.

    The File class (exported as Document) is the main entry point for creating DOCX documents. It manages all document components including content, styles, numbering, headers/footers, and media. Documents are organized into sections, each of which can have its own page settings, headers, and footers.

    This class handles the assembly of all OOXML parts required for a valid .docx file, including relationships, content types, and document properties.

    // Simple document with one section
    const doc = new Document({
      sections: [{
        children: [
          new Paragraph("Hello World"),
        ],
      }],
    });

    // Document with multiple sections and headers/footers
    const doc = new Document({
      creator: "John Doe",
      sections: [
        {
          headers: {
            default: new Header({
              children: [new Paragraph("Header Text")],
            }),
          },
          children: [
            new Paragraph("Section 1 content"),
          ],
        },
        {
          children: [
            new Paragraph("Section 2 content"),
          ],
        },
      ],
    });

    // Document with custom styles and numbering
    const doc = new Document({
      styles: {
        paragraphStyles: [
          {
            id: "MyHeading",
            name: "My Heading",
            basedOn: "Heading1",
            run: { bold: true, color: "FF0000" },
          },
        ],
      },
      numbering: {
        config: [
          {
            reference: "my-numbering",
            levels: [
              { level: 0, format: "decimal", text: "%1.", alignment: "left" },
            ],
          },
        ],
      },
      sections: [{
        children: [new Paragraph("Content")],
      }],
    });
    Index
    constructor
    AppProperties Bibliography Comments CommentsExtended CommentsIds ContentTypes CoreProperties CustomProperties Document Endnotes FileRelationships FontTable Footers FootNotes Headers Macros Media Numbering PackageParts Settings Styles Theme
    • get AppProperties(): AppProperties

      Returns AppProperties

    • get Bibliography(): FileBibliography | undefined

      The document's sources, when it has a bibliography: the part they're in (customXml/item1.xml), its properties (customXml/itemProps1.xml), and its relationships, to its properties.

      Returns FileBibliography | undefined

    • get ContentTypes(): ContentTypes

      Returns ContentTypes

    • get CoreProperties(): CoreProperties

      Returns CoreProperties

    • get CustomProperties(): CustomProperties

      Returns CustomProperties

    • get Document(): DocumentWrapper

      Returns DocumentWrapper

    • get Endnotes(): EndnotesWrapper

      Returns EndnotesWrapper

    • get FileRelationships(): Relationships

      Returns Relationships

    • get FootNotes(): FootnotesWrapper

      Returns FootnotesWrapper

    • get Macros(): FileMacros | undefined

      The document's macros, when it has any: its VBA project (word/vbaProject.bin), the events of the document it handles (word/vbaData.xml), and the project's relationships, to the events.

      Returns FileMacros | undefined

    • get PackageParts(): PackageParts

      The parts that drawings, such as charts, add to the package when it is written.

      Returns PackageParts

    Settings
    Member Visibility

    On This Page
    Constructors
    Accessors