json-condenser

Condenses JSON by shortening literals

Usage no npm install needed!

<script type="module">
  import jsonCondenser from 'https://cdn.skypack.dev/json-condenser';
</script>

README

json-condenser

Condenses JSON by shortening literals and numbers

json-condenser makes JSON shorter but still (kind of) human-readable. Great for embedding JSON data in URLs.

const KEYS = ['id', 'name', 'email', 'role', 'admin']
const json = [{"id":1,"name":"John","email":"john@gmail.com","role":"admin"}]

let payload = condense(KEYS, json)
//=> [{e:1,f:"John",g:"john@gmail.com",h:i}]

expand(KEYS, payload)
//=> [{"id":1,"name":"John","email":"john@gmail.com","role":"admin"}]

Status

API

condense

condense(keys, json)

Condenses a JSON string json by shortening the keys in keys into letters.

  • keys (Array of strings) - key names to be abbreviated.
  • json (String) - A JSON string as given by JSON.stringify(). It should not have any whitespaces.

expand

expand(keys, condensedJson)

Expands an output of condense().

  • keys (Array of strings) - The same keys passed onto condense().
  • condensedJson (String) - The output of condense().

Thanks

json-condenser © 2016+, Rico Sta. Cruz. Released under the MIT License.
Authored and maintained by Rico Sta. Cruz with help from contributors (list).

ricostacruz.com  ·  GitHub @rstacruz  ·  Twitter @rstacruz