Class: JSONPatch

jsonpatch.JSONPatch

Constructors

constructor

• new JSONPatch(ops?): JSONPatch

Parameters

Name	Type
ops?	OpObject[]

Returns

JSONPatch

Defined in

src/patch/patch.ts:361

Properties

ops

• Private ops: Op[] = []

Defined in

src/patch/patch.ts:355

Methods

[iterator]

▸ [iterator](): Iterator<OpObject, any, undefined>

Returns

Iterator<OpObject, any, undefined>

an iterator over ops in this patch.

Defined in

src/patch/patch.ts:370

---

add

▸ add(path, value): this

Parameters

Name	Type
path	string | JSONPointer
value	JSONValue

Returns

this

Defined in

src/patch/patch.ts:382

---

apply

▸ apply(value): JSONValue

Parameters

Name	Type
value	JSONValue

Returns

JSONValue

Defined in

src/patch/patch.ts:464

---

build

▸ build(ops): void

Parameters

Name	Type
ops	OpObject[]

Returns

void

Defined in

src/patch/patch.ts:488

---

copy

▸ copy(from, path): this

Parameters

Name	Type
from	string | JSONPointer
path	string | JSONPointer

Returns

this

Defined in

src/patch/patch.ts:437

---

ensurePointer

▸ ensurePointer(p, op, index): JSONPointer

Parameters

Name	Type
p	string | JSONPointer
op	string
index	number

Returns

JSONPointer

Defined in

src/patch/patch.ts:574

---

move

▸ move(from, path): this

Parameters

Name	Type
from	string | JSONPointer
path	string | JSONPointer

Returns

this

Defined in

src/patch/patch.ts:422

---

opPointer

▸ opPointer(opObj, key, op, index): JSONPointer

Parameters

Name	Type
opObj	OpObject
key	keyof OpObject
op	string
index	number

Returns

JSONPointer

Defined in

src/patch/patch.ts:533

---

opValue

▸ opValue(opObj, key, op, index): JSONValue

Parameters

Name	Type
opObj	OpObject
key	keyof OpObject
op	string
index	number

Returns

JSONValue

Defined in

src/patch/patch.ts:561

---

remove

▸ remove(path): this

Parameters

Name	Type
path	string | JSONPointer

Returns

this

Defined in

src/patch/patch.ts:393

---

replace

▸ replace(path, value): this

Parameters

Name	Type
path	string | JSONPointer
value	JSONValue

Returns

this

Defined in

src/patch/patch.ts:406

---

test

▸ test(path, value): this

Parameters

Name	Type
path	string | JSONPointer
value	JSONValue

Returns

this

Defined in

src/patch/patch.ts:453

---

toArray

▸ toArray(): OpObject[]

Returns

OpObject[]

Defined in

src/patch/patch.ts:484