https://github.com/spencermountain/garbage-patch
not the smartest json-patch implementation
https://github.com/spencermountain/garbage-patch
Last synced: about 1 month ago
JSON representation
not the smartest json-patch implementation
- Host: GitHub
- URL: https://github.com/spencermountain/garbage-patch
- Owner: spencermountain
- License: mit
- Created: 2021-05-22T16:46:46.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2021-10-31T19:52:08.000Z (over 3 years ago)
- Last Synced: 2025-03-11T21:39:40.029Z (about 1 month ago)
- Language: JavaScript
- Size: 135 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
**[JSON Patch](http://jsonpatch.com/)** is a neat idea for describing changes to JSON -
... the idea is that you can clean-up muddled parts of a codebase, by making data-things explicit.
it is pretty simple, and sort of beautiful.
Does the world need another json-patch implementation? no.
did I make one, and is it crappy? **yes.**
garbage-patch
```js
import { get, make, apply } = from 'garbage-patch'
let json = {
foo: ['bar', 'baz'],
}
// apply clean changes to the json
let patch = { op: 'add', path: '/foo/-', value: 'bob' }
apply(patch, json)
/* {
foo: ['bar', 'baz', 'bob'],
} */
// make a valid json pointer
let ptr = make(['foo', 1])
// '/foo/1'
// use it to get some data
let result = get(ptr, json)
// 'baz'
```
there is nothing too-clever going on. the min.js build is **_2.5kb_**.
---
these methods _take inspiration_ from the [pointer spec](https://datatracker.ietf.org/doc/html/rfc6901)
and the [patch-spec](https://datatracker.ietf.org/doc/html/rfc6902) but have some differences:
1. **get()** is more-forgiving
if you give it a path '/foo/typo/9/wrong' that doesn't exist,
it will just say - '_haha! no problem! **undefined**! ✌_'
also, a trailing slash is allowed - `/foo/`
also, a leading slash is optional - `foo/1`
if you prefer, you can use an array as a pointer, too:
```js
let json = { foo: [null, 'found'] }
let found = get(['foo', 1], json)
// 'found'
```
2. **apply()** changes in-place (mutable)
-and before you think _'hey this guy has never seen that Rich Hickey talk'_ - I have seen that one.
most javascript implementations call **.clone()** over and over.
3. **- sneaky-append -** an **_'add'_** patch on an array doesn't need an index, and assumes a push on an array:
```js
let json = { foo: [1] }
// according to the spec, this must be '/foo/[index]', which seemed annoying
let patch = { op: 'add', path: '/foo', value: 2 }
json = apply(patch, json) //normally this would be an arror
// {foo: [1, 2]}
```
4. **- sneaky-splat -** an **_'add'_** patch on an object doesn't need an key, if the value is also an object:
```js
let json = { foo: { bar: true } }
let patch = { op: 'add', path: '/foo', value: { baz: true } }
apply(patch, json) //this would normally be an error, i think.
// { foo: { bar: true, baz: true } }
```
### API
- **make(props)** - create a JSON pointer from a list of properties
- **get(pntr,json)** - use a pointer to get data out of JSON
- **apply(patch, json)** - make modifications to a JSON object (in place)
all the different build formats are in `./builds`
there's a **get** only build, that is < 1kb:
```js
import { get } from 'garbage-patch'
```
```js
const get = require('garbage-patch/get')
```
### See Also
- [json-patch](https://github.com/dharmafly/jsonpatch.js) - 7kb
- [fast-json-patch](https://github.com/Starcounter-Jack/JSON-Patch/blob/master/dist/fast-json-patch.min.js) - 12kb
- [json-8](https://github.com/sonnyp/JSON8/tree/master/packages/patch) - 11kb
- [jiff](https://github.com/cujojs/jiff) - 12kb
MIT
