Error handling

This section is about how to handle Docxtemplater errors.

To be able to see these errors, you need to catch them properly.

try {
    // render the document (replace all occurences of {first_name} by John, {last_name} by Doe, ...)
    doc.render()
}
catch (error) {
    var e = {
        message: error.message,
        name: error.name,
        stack: error.stack,
        properties: error.properties,
    }
    console.log(JSON.stringify(e));
    // Handle error
}

Error Schema

All errors thrown by docxtemplater have the following schema:

{
    name: One of [GenericError, TemplateError, ScopeParserError, InternalError, MultiError],
    message: The message of that error,
    properties : {
        explanation: An error that is user friendly (in english), explaining what failed exactly. This error could be shown as is to end users
        id: An identifier of the error that is unique for that type of Error
        ... : The other properties are specific to each type of error.
    }
}

Error example

If the content of your template is {user {name}, docxtemplater will throw the following error :

try {
    doc.render()
}
catch (e) {
    // All these expressions are true
    e.name === "TemplateError"
    e.message === "Unclosed tag"
    e.properties.explanation === "The tag beginning with '{user ' is unclosed"
    e.properties.id === "unclosed_tag"
    e.properties.context === "{user {"
    e.properties.xtag === "user "
}

Error Identifier

All errors can be identified with their id (e.properties.id).

The ids are :

multi_error: This error means that multiple errors where found in the template (1 or more). See below for handling these errors.

unopened_tag: This error happens if a tag is closed but not opened. For example with the following template :

Hello name} !

unclosed_tag: This error happens if a tag is opened but not closed. For example with the following template :

Hello {name !

no_xml_tag_found_at_left and no_xml_tag_found_at_right: This error happens if a rawXMLTag does’nt find a <w:p> element

<w:p><w:t>{@raw}</w:t>
// Note  that the `</w:p>` tag is missing.

utf8_decode is an internal error, please report it if you see it

xmltemplater_content_must_be_string is an internal error that happens if you try to template something that is not a string (a number for example)

raw_xml_tag_should_be_only_text_in_paragraph happens when a rawXMLTag {@raw} is not the only text in the paragraph. For example, writing ` {@raw}` (Note the spaces) is not acceptable because the {@raw} tag replaces the full paragraph. We prefer to throw an Error now rather than have “strange behavior” because the spaces “disappeared”.

To correct this error, you have to add manually the text that you want in your raw tag. (Or you can use the https://modules.docxtemplater.com/modules/word-run/ which adds a tag that can replace rawXML inside a tag).

Writing

` {@my_first_tag}{my_second_tag} `

Or even

` Hello {@my_first_tag} `

Is misusing docxtemplater.

The @ at the beginning means “replace the xml of the current paragraph with scope.my_first_tag” so that means that everything else in that Paragraph will be removed.

A workaround is to put the text of the second tag in the first tag. (The tag must of course be valid xml)

Hello {@raw} !

unclosed_loop and unopened_loop happen when a loop is closed but never opened : for example

{#users}{name}

or

{name}{/users}

closing_tag_does_not_match_opening_tag happens when a loop is closed but doesn’t match the opening tag

{#users}{name}{/people}

scopeparser_compilation_failed happens when your parser throws an error during compilation. The parser is defined in doc.setOptions({parser: function parser(tag) {}})

For example, if your template is :

{name++}

and you use the angularParser, you will have this error. The error happens when you call parser(‘name++’); The underlying error ca be read in e.properties.rootError

unimplemented_tag_type happens when a tag type is not implemented. It should normally not happen, unless you changed docxtemplater code.

malformed_xml happens when a xml file of the document cannot be parsed correctly.

Handling multiple errors

docxtemplater now has the ability to detect multiple errors in your template. If it detects multiple errors, it will throw an error that has the id multi_error

You can then have the following to view all errors :

e.properties.errors.forEach(function(err) {
    console.log(err);
});