Function●Since v1.0

applyPatch

Apply a full JSON Patch array on a JSON document. Returns the {newDocument, result} of the patch. It modifies the document object and patch - it gets the values by reference. If you would like to avoid touching your values, clone them: jsonpatch.applyPatch(document, jsonpatch._deepClone(patch)).

applyPatch<
  T
>(
  document: T,
  patch: readonly Operation[],
  validateOperation: boolean | Validator<T>,
  mutateDocument: boolean = true,
  banPrototypeModifications: boolean = true
): PatchResult<T>

Parameters

Name	Type	Description
`document`*	`T`	The document to patch
`patch`*	`readonly Operation[]`	The patch to apply
`validateOperation`	`boolean \| Validator<T>`	`false` is without validation, `true` to use default jsonpatch's validation, or you can pass a `validateOperation` callback to be used for validation.
`mutateDocument`	`boolean`	Default:`true` Whether to mutate the original document or clone it before applying
`banPrototypeModifications`	`boolean`	Default:`true` Whether to ban modifications to `__proto__`, defaults to `true`.

View source on GitHub

applyPatch

Parameters

LangChain Assistant

Menu

applyPatch

Parameters