JavaScript API: addBreak

CONTENTS

LAYOUTS

SETTINGS

STYLES

TEMPLATES

OTHERS

addBreak

PREMIUM

TRIAL / ADVANCED

Adds break.

Note

You are reading the JavaScript API documentation. For the PHP API method please go to addBreak.

Description

addBreak (type: BreakType = "line", options: OptionsBreak = {}): this

type BreakType = "line" | "page" | "column";

interface OptionsBreak {}

Code samples

Example #1

import { CreateDocx } from "build";
import * as fs from "fs";

const docx = new CreateDocx();

docx.addText("New content.");

docx.addBreak("page");

docx.addText("Content in a new page.");

docx.save().then(contents => {
    fs.writeFileSync("addBreak_1.docx", Buffer.from(contents));
});

The resulting Word document looks like:

Release notes

phpdocx 15.0:
- new method.