Skip to main content

Class: JSONPatch

Defined in: src/patch/patch.ts:296

Constructors​

Constructor​

new JSONPatch(ops?): JSONPatch

Defined in: src/patch/patch.ts:299

Parameters​

ops?​

OpObject[]

Returns​

JSONPatch

Methods​

[iterator]()​

[iterator](): Iterator<OpObject>

Defined in: src/patch/patch.ts:308

Returns​

Iterator<OpObject>

an iterator over ops in this patch.

add()​

add(path, value): this

Defined in: src/patch/patch.ts:314

Parameters​

path​

string | JSONPointer

value​

JSONValue

Returns​

this

apply()​

apply(value): JSONValue

Defined in: src/patch/patch.ts:354

Parameters​

value​

JSONValue

Returns​

JSONValue

build()​

protected build(ops): void

Defined in: src/patch/patch.ts:375

Parameters​

ops​

OpObject[]

Returns​

void

copy()​

copy(from, path): this

Defined in: src/patch/patch.ts:339

Parameters​

from​

string | JSONPointer

path​

string | JSONPointer

Returns​

this

ensurePointer()​

protected ensurePointer(p, op, index): JSONPointer

Defined in: src/patch/patch.ts:456

Parameters​

p​

string | JSONPointer

op​

string

index​

number

Returns​

JSONPointer

move()​

move(from, path): this

Defined in: src/patch/patch.ts:329

Parameters​

from​

string | JSONPointer

path​

string | JSONPointer

Returns​

this

opPointer()​

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

Defined in: src/patch/patch.ts:420

Parameters​

opObj​

OpObject

key​

keyof OpObject

op​

string

index​

number

Returns​

JSONPointer

opValue()​

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

Defined in: src/patch/patch.ts:448

Parameters​

opObj​

OpObject

key​

keyof OpObject

op​

string

index​

number

Returns​

JSONValue

remove()​

remove(path): this

Defined in: src/patch/patch.ts:319

Parameters​

path​

string | JSONPointer

Returns​

this

replace()​

replace(path, value): this

Defined in: src/patch/patch.ts:324

Parameters​

path​

string | JSONPointer

value​

JSONValue

Returns​

this

test()​

test(path, value): this

Defined in: src/patch/patch.ts:349

Parameters​

path​

string | JSONPointer

value​

JSONValue

Returns​

this

toArray()​

toArray(): OpObject[]

Defined in: src/patch/patch.ts:371

Returns​

OpObject[]