Document the default value for mutateDocument

README.md

@@ -93,7 +93,7 @@ Applies `patch` array on `obj`.
 - `document` The document to patch
 - `patch` a JSON-Patch array of operations to apply
 - `validateOperation` Boolean for whether to validate each operation with our default validator, or to pass a validator callback
-- `mutateDocument` Whether to mutate the original document or clone it before applying
+- `mutateDocument` Whether to mutate the original document or clone it before applying, defaults to `true`
 - `banPrototypeModifications`  Whether to ban modifications to `__proto__`, defaults to `true`.
 
 An invalid patch results in throwing an error (see `jsonpatch.validate` for more information about the error object).
@@ -133,7 +133,7 @@ Applies single operation object `operation` on `document`.
 - `document` The document to patch
 - `operation` The operation to apply
 - `validateOperation` Whether to validate the operation, or to pass a validator callback
-- `mutateDocument` Whether to mutate the original document or clone it before applying
+- `mutateDocument` Whether to mutate the original document or clone it before applying, defaults to `true`
 - `banPrototypeModifications` Whether to ban modifications to `__proto__`, defaults to `true`.
 - `index` The index of the operation in your patch array. Useful for better error reporting when that operation fails to apply.
 

commonjs/core.js

@@ -103,7 +103,7 @@ exports.getValueByPointer = getValueByPointer;
  * @param document The document to patch
  * @param operation The operation to apply
  * @param validateOperation `false` is without validation, `true` to use default jsonpatch's validation, or you can pass a `validateOperation` callback to be used for validation.
- * @param mutateDocument Whether to mutate the original document or clone it before applying
+ * @param mutateDocument Whether to mutate the original document or clone it before applying, defaults to `true`
  * @param banPrototypeModifications Whether to ban modifications to `__proto__`, defaults to `true`.
  * @return `{newDocument, result}` after the operation
  */
@@ -259,7 +259,7 @@ exports.applyOperation = applyOperation;
  * @param document The document to patch
  * @param patch The patch to apply
  * @param validateOperation `false` is without validation, `true` to use default jsonpatch's validation, or you can pass a `validateOperation` callback to be used for validation.
- * @param mutateDocument Whether to mutate the original document or clone it before applying
+ * @param mutateDocument Whether to mutate the original document or clone it before applying, defaults to `true`
  * @param banPrototypeModifications Whether to ban modifications to `__proto__`, defaults to `true`.
  * @return An array of `{newDocument, result}` after the patch
  */

dist/fast-json-patch.js

@@ -382,7 +382,7 @@ exports.getValueByPointer = getValueByPointer;
  * @param document The document to patch
  * @param operation The operation to apply
  * @param validateOperation `false` is without validation, `true` to use default jsonpatch's validation, or you can pass a `validateOperation` callback to be used for validation.
- * @param mutateDocument Whether to mutate the original document or clone it before applying
+ * @param mutateDocument Whether to mutate the original document or clone it before applying, defaults to `true`
  * @param banPrototypeModifications Whether to ban modifications to `__proto__`, defaults to `true`.
  * @return `{newDocument, result}` after the operation
  */
@@ -538,7 +538,7 @@ exports.applyOperation = applyOperation;
  * @param document The document to patch
  * @param patch The patch to apply
  * @param validateOperation `false` is without validation, `true` to use default jsonpatch's validation, or you can pass a `validateOperation` callback to be used for validation.
- * @param mutateDocument Whether to mutate the original document or clone it before applying
+ * @param mutateDocument Whether to mutate the original document or clone it before applying, defaults to `true`
  * @param banPrototypeModifications Whether to ban modifications to `__proto__`, defaults to `true`.
  * @return An array of `{newDocument, result}` after the patch
  */
@@ -925,4 +925,4 @@ exports.compare = compare;
 
 
 /***/ })
-/******/ ]);
+/******/ ]);

module/core.d.ts

@@ -62,7 +62,7 @@ export declare function getValueByPointer(document: any, pointer: string): any;
  * @param document The document to patch
  * @param operation The operation to apply
  * @param validateOperation `false` is without validation, `true` to use default jsonpatch's validation, or you can pass a `validateOperation` callback to be used for validation.
- * @param mutateDocument Whether to mutate the original document or clone it before applying
+ * @param mutateDocument Whether to mutate the original document or clone it before applying, defaults to `true`
  * @param banPrototypeModifications Whether to ban modifications to `__proto__`, defaults to `true`.
  * @return `{newDocument, result}` after the operation
  */
@@ -77,7 +77,7 @@ export declare function applyOperation<T>(document: T, operation: Operation, val
  * @param document The document to patch
  * @param patch The patch to apply
  * @param validateOperation `false` is without validation, `true` to use default jsonpatch's validation, or you can pass a `validateOperation` callback to be used for validation.
- * @param mutateDocument Whether to mutate the original document or clone it before applying
+ * @param mutateDocument Whether to mutate the original document or clone it before applying, defaults to `true`
  * @param banPrototypeModifications Whether to ban modifications to `__proto__`, defaults to `true`.
  * @return An array of `{newDocument, result}` after the patch
  */

module/core.mjs

@@ -101,7 +101,7 @@ export function getValueByPointer(document, pointer) {
  * @param document The document to patch
  * @param operation The operation to apply
  * @param validateOperation `false` is without validation, `true` to use default jsonpatch's validation, or you can pass a `validateOperation` callback to be used for validation.
- * @param mutateDocument Whether to mutate the original document or clone it before applying
+ * @param mutateDocument Whether to mutate the original document or clone it before applying, defaults to `true`
  * @param banPrototypeModifications Whether to ban modifications to `__proto__`, defaults to `true`.
  * @return `{newDocument, result}` after the operation
  */
@@ -256,7 +256,7 @@ export function applyOperation(document, operation, validateOperation, mutateDoc
  * @param document The document to patch
  * @param patch The patch to apply
  * @param validateOperation `false` is without validation, `true` to use default jsonpatch's validation, or you can pass a `validateOperation` callback to be used for validation.
- * @param mutateDocument Whether to mutate the original document or clone it before applying
+ * @param mutateDocument Whether to mutate the original document or clone it before applying, defaults to `true`
  * @param banPrototypeModifications Whether to ban modifications to `__proto__`, defaults to `true`.
  * @return An array of `{newDocument, result}` after the patch
  */