Class Patch

Implementation of IETF RFC 6902 JSON Patch.

JavaScript Object Notation (JSON) Patch defines a JSON document structure for expressing a sequence of operations to apply to a JavaScript Object Notation (JSON) document; it is suitable for use with the HTTP PATCH method. The "application/json-patch+json" media type is used to identify such patch documents.

Patch

Index

Constructors

constructor

Methods

apply create diff

Constructors

constructor

new Patch(): Patch
Returns Patch

Methods

apply

apply(sourceDocument: JSONObject, operations: PatchOperation[]): JSONObject
Applies a JSON Patch to a source document and returns the patched document.
Parameters
- sourceDocument: JSONObject
  The source document to patch.
- operations: PatchOperation[]
  The JSON Patch operations to apply.
Returns JSONObject
The patched document.

Throws
If an unsupported operation is provided.
- Defined in patch.ts:23

create

create(patches: PatchOperation[]): PatchOperation[]
Constructs a JSON Patch with a single operation (e.g. add service).
Parameters
- patches: PatchOperation[]
  The patch operation to create.
Returns PatchOperation[]
A single-entry JSON Patch array.
- Defined in patch.ts:82

diff

diff(
    sourceDocument: JSONObject,
    targetDocument: JSONObject,
    path: string,
): PatchOperation[]
Find the diff between a source and target document constructing the patch operations from source => target.
Parameters
- sourceDocument: JSONObject
  The original JSON object.
- targetDocument: JSONObject
  The target JSON object to transform into.
- path: string
Returns PatchOperation[]
An array of JSON Patch operations.
- Defined in patch.ts:104

Class Patch

Index

Constructors

Methods

Constructors

constructor

Returns Patch

Methods

apply

Parameters

Returns JSONObject

Throws

create

Parameters

Returns PatchOperation[]

diff

Parameters

Returns PatchOperation[]

Settings

On This Page