docx/dist/file/file.d.ts

Easily generate .docx files with JS/TS with a nice declarative API. Works for Node and on the Browser.

import { AppProperties } from './app-properties/app-properties';
import { ContentTypes } from './content-types/content-types';
import { CoreProperties, IPropertiesOptions } from './core-properties';
import { CustomProperties } from './custom-properties';
import { ISectionPropertiesOptions } from './document/body/section-properties';
import { DocumentWrapper } from './document-wrapper';
import { EndnotesWrapper } from './endnotes-wrapper';
import { FileChild } from './file-child';
import { FontWrapper } from './fonts/font-wrapper';
import { FooterWrapper } from './footer-wrapper';
import { FootnotesWrapper } from './footnotes-wrapper';
import { Footer, Header } from './header';
import { HeaderWrapper } from './header-wrapper';
import { Media } from './media';
import { Numbering } from './numbering';
import { Comments } from './paragraph/run/comment-run';
import { CommentsExtended } from './paragraph/run/comments-extended';
import { Relationships } from './relationships';
import { Settings } from './settings';
import { Styles } from './styles';
export type ISectionOptions = {
    readonly headers?: {
        readonly default?: Header;
        readonly first?: Header;
        readonly even?: Header;
    };
    readonly footers?: {
        readonly default?: Footer;
        readonly first?: Footer;
        readonly even?: Footer;
    };
    readonly properties?: ISectionPropertiesOptions;
    readonly children: readonly FileChild[];
};
export declare class File {
    private currentRelationshipId;
    private readonly documentWrapper;
    private readonly headers;
    private readonly footers;
    private readonly coreProperties;
    private readonly numbering;
    private readonly media;
    private readonly fileRelationships;
    private readonly footnotesWrapper;
    private readonly endnotesWrapper;
    private readonly settings;
    private readonly contentTypes;
    private readonly customProperties;
    private readonly appProperties;
    private readonly styles;
    private readonly comments;
    private readonly commentsExtended?;
    private readonly fontWrapper;
    constructor(options: IPropertiesOptions);
    private addSection;
    private createHeader;
    private createFooter;
    private addHeaderToDocument;
    private addFooterToDocument;
    private addDefaultRelationships;
    get Document(): DocumentWrapper;
    get Styles(): Styles;
    get CoreProperties(): CoreProperties;
    get Numbering(): Numbering;
    get Media(): Media;
    get FileRelationships(): Relationships;
    get Headers(): readonly HeaderWrapper[];
    get Footers(): readonly FooterWrapper[];
    get ContentTypes(): ContentTypes;
    get CustomProperties(): CustomProperties;
    get AppProperties(): AppProperties;
    get FootNotes(): FootnotesWrapper;
    get Endnotes(): EndnotesWrapper;
    get Settings(): Settings;
    get Comments(): Comments;
    get CommentsExtended(): CommentsExtended | undefined;
    get FontTable(): FontWrapper;
}