Updated CHANGELOG and bumped version number

guigrpa · Jun 15, 2020 · 80b2ded · 80b2ded
1 parent 4dfdbfd
commit 80b2ded
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,7 @@
+## 4.2.0 (2020-06-15)
+* Feature: added 'rejectNullish' setting. When set to `true`, this setting ensures `createReport` throws a `NullishCommandResultError` when the result of an INS, HTML, IMAGE, or LINK command is `null` or `undefined`. This is useful as nullish return values usually indicate a mistake in the template or the invoking code. Defaults to `false`.
+* Enhancement: typed Errors to facilitate more fine-grained downstream error handling.
+
 ## 4.1.1 (2020-06-06)
 * [PR #121](https://github.com/guigrpa/docx-templates/pull/121) Improved detection of built-in commands in templates to avoid confusion with javascript symbols.
 * [#107](https://github.com/guigrpa/docx-templates/issues/107) Library now correctly recognizes user-defined commands with non-alphanumeric names (like Chinese characters).

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "docx-templates",
-  "version": "4.1.1",
+  "version": "4.2.0",
   "description": "Template-based docx report creation",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",

diff --git a/src/types.ts b/src/types.ts
@@ -97,7 +97,7 @@ export type UserOptions = {
   failFast?: boolean;
 
   /**
-   * When set to `true`, this setting ensures `createReport` throws an error when the result of an INS, HTML, IMAGE, or LINK command is `null` or `undefined`. This is useful as nullish return values usually indicate a mistake in the template or the invoking code. Defaults to `false`.
+   * When set to `true`, this setting ensures `createReport` throws a `NullishCommandResultError` when the result of an INS, HTML, IMAGE, or LINK command is `null` or `undefined`. This is useful as nullish return values usually indicate a mistake in the template or the invoking code. Defaults to `false`.
    */
   rejectNullish?: boolean;
 };