🏷️ Limited Offer: 40% OFF 🏷️

First 100 purchases only — Special discount!

Use this coupon on checkout: PHPDXPJ_D1SC1N5T

Get it now

getTemplateSymbols

Gets template symbols.

Description

getTemplateSymbols (): [string, string]

By default jsdocuments template variables have to be wrapped by dollar symbols ($).

These symbols can be changed by custom ones using setTemplateSymbols .

The character or symbol used to wrap template variables may be:

  • The same at the beginning and the end: $VAR$, |VAR|, #VAR#...
  • Different at the beginning and the end: ${VAR}, #{VAR}, [[VAR]], «VAR»...

Code samples

Example #1

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

const docxTemplate = fs.readFileSync("template.docx").buffer;

const docx = new CreateDocx();
// load the template
docx.openTemplate(docxTemplate).then(docx => {
    // get template symbols
    let templateSymbols = docx.getTemplateSymbols();
    console.log(templateSymbols);

    // set a custom template symbol
    docx.setTemplateSymbols("${", "}");

    // get template symbols
    templateSymbols = docx.getTemplateSymbols();
    console.log(templateSymbols);
});

Release notes

  • jsdocuments 1.0:
    • New method