Introduction
Flattenr is a utility that make a JSON data to flat map. Be more safe and readable. Change standard JSON format such this one:
to this:
Why choose the flatten way?
In my opinion, hashmap is good structured data type. When encounter with nested, and very deep JSON data flattenr will help us to create hashmap data type. I use it as a data formatter for my personal project.
Usage
Flattenr.js can be installed using npm or bower. To install flattenr.js via npm:
npm install flattenr --save
Suppose I have standard formatted JSON data from http://www.json-generator.com/:
var objects = "id": 0 "guid": "cc38bed5-5fd4-44a8-896c-8429a73fffa1" "isActive": false "balance": "$2,781.00" "picture": "http://placehold.it/32x32" "age": 23 "name": "Head Wade" "gender": "male" "company": "Zolarex" "email": "headwade@zolarex.com" "phone": "+1 (878) 548-3497" "address": "264 Quay Street, Mathews, Michigan, 7116" "about": "Mollit qui id nisi in excepteur fugiat. Ut tempor proident pariatur veniam exercitation elit est. Ex pariatur eu consectetur do et laborum minim.\r\n" "registered": "1999-05-29T18:44:25 -07:00" "latitude": 4504479 "longitude": 114016977 "tags": "veniam" "aliqua" "laborum" "proident" "eu" "ullamco" "do" "friends": "id": 0 "name": "Villarreal Mcpherson" "id": 1 "name": "Horton Rosa" "id": 2 "name": "Small Malone" "randomArrayItem": "lemon" "id": 1 "guid": "d1fad964-63c5-4dd5-a2a1-ea306ad1967e" "isActive": false "balance": "$2,569.00" "picture": "http://placehold.it/32x32" "age": 27 "name": "Georgina Dawson" "gender": "female" "company": "Gallaxia" "email": "georginadawson@gallaxia.com" "phone": "+1 (862) 478-2597" "address": "770 Ridgewood Avenue, Makena, South Carolina, 4979" "about": "Occaecat ullamco dolore exercitation laborum anim. Sunt incididunt duis cillum aute consequat anim irure reprehenderit occaecat. Occaecat id magna aliqua incididunt sunt enim fugiat dolor tempor mollit irure sint id ullamco. Magna Lorem cillum et sint pariatur amet. Commodo velit ex qui elit magna.\r\n" "registered": "1996-01-11T11:31:11 -07:00" "latitude": 69709229 "longitude": -141610235 "tags": "Lorem" "et" "aute" "adipisicing" "culpa" "commodo" "eiusmod" "friends": "id": 0 "name": "Morris Rosales" "id": 1 "name": "Lara Reilly" "id": 2 "name": "Steele Fitzpatrick" "randomArrayItem": "lemon" "id": 2 "guid": "57db458e-b831-465d-b8b8-9726b85611bf" "isActive": true "balance": "$3,345.00" "picture": "http://placehold.it/32x32" "age": 33 "name": "Bean Stark" "gender": "male" "company": "Zilidium" "email": "beanstark@zilidium.com" "phone": "+1 (958) 506-3057" "address": "994 Rugby Road, Clinton, Idaho, 3249" "about": "Fugiat nulla ullamco est irure sunt deserunt do mollit nulla eu mollit irure. Esse do Lorem minim nostrud commodo deserunt nisi qui dolor. Id ut exercitation ipsum ut. Dolore anim excepteur nulla anim aute nostrud aliqua dolor ex consequat id tempor reprehenderit. Qui non pariatur exercitation nisi in. Ex minim sint deserunt ex qui.\r\n" "registered": "1997-10-04T16:58:03 -07:00" "latitude": -55883112 "longitude": -69844223 "tags": "deserunt" "velit" "eiusmod" "ullamco" "Lorem" "enim" "eu" "friends": "id": 0 "name": "Mooney Curry" "id": 1 "name": "Dolores Campbell" "id": 2 "name": "Bridgett Young" "randomArrayItem": "cherry" "id": 3 "guid": "55bfadf9-320e-4523-b7c3-f5415ed28fd5" "isActive": false "balance": "$1,856.00" "picture": "http://placehold.it/32x32" "age": 26 "name": "Lolita Roman" "gender": "female" "company": "Pivitol" "email": "lolitaroman@pivitol.com" "phone": "+1 (870) 480-3483" "address": "595 Fulton Street, Sabillasville, Colorado, 5843" "about": "In officia cillum nostrud mollit occaecat consequat ullamco voluptate veniam id voluptate. Nisi minim minim minim anim ut do magna eu irure occaecat ea sit velit exercitation. Nostrud incididunt cillum irure tempor ex ex officia culpa qui anim quis sunt labore aliquip. Amet minim consectetur nulla aliquip anim velit tempor ullamco aliqua velit excepteur deserunt sunt. Commodo consequat exercitation eiusmod eiusmod nisi mollit aute laborum irure laborum consectetur exercitation.\r\n" "registered": "2005-04-26T18:32:03 -07:00" "latitude": 38922275 "longitude": -86762296 "tags": "consectetur" "occaecat" "velit" "amet" "tempor" "eiusmod" "id" "friends": "id": 0 "name": "Nielsen Charles" "id": 1 "name": "Gabriela Jenkins" "id": 2 "name": "Russo Willis" "randomArrayItem": "lemon" "id": 4 "guid": "487bf1fa-a837-4bb0-ace5-9af814b60b32" "isActive": true "balance": "$3,705.00" "picture": "http://placehold.it/32x32" "age": 40 "name": "Diane Velez" "gender": "female" "company": "Ginkogene" "email": "dianevelez@ginkogene.com" "phone": "+1 (844) 582-3820" "address": "982 Agate Court, Nash, Hawaii, 7910" "about": "Minim irure nulla est elit magna occaecat dolore officia ipsum et incididunt laborum sint. Minim aliquip laborum aliqua in nulla do officia. Nulla et excepteur deserunt velit commodo ad aliqua aliqua incididunt anim irure quis ut cillum. Ut elit ad id duis aliquip ad in esse eiusmod labore. Mollit ex aute enim ad ex duis elit veniam id sunt do ipsum aute laboris. Dolor fugiat ea fugiat reprehenderit nisi incididunt Lorem laborum aute anim in voluptate.\r\n" "registered": "1998-05-31T14:18:09 -07:00" "latitude": -73719046 "longitude": 131088866 "tags": "sint" "nisi" "sunt" "sint" "aliquip" "ex" "labore" "friends": "id": 0 "name": "Kristi Stafford" "id": 1 "name": "Berry Holcomb" "id": 2 "name": "Strong Lott" "randomArrayItem": "lemon" "id": 5 "guid": "907644af-19bc-42f8-aa0a-9e40abbf0bdf" "isActive": true "balance": "$2,211.00" "picture": "http://placehold.it/32x32" "age": 21 "name": "Bradshaw Vazquez" "gender": "male" "company": "Recognia" "email": "bradshawvazquez@recognia.com" "phone": "+1 (998) 428-2316" "address": "790 Jerome Street, Tolu, Oklahoma, 5220" "about": "Incididunt occaecat deserunt anim fugiat nulla nulla ea anim culpa nulla veniam sunt tempor. Nostrud minim consequat dolore do elit culpa dolor occaecat. Elit irure officia tempor nostrud adipisicing aliqua magna nisi aute consequat consequat consequat. Non amet commodo voluptate labore magna ad reprehenderit velit tempor.\r\n" "registered": "2002-11-01T09:30:17 -07:00" "latitude": -84470438 "longitude": -9996739 "tags": "duis" "qui" "aute" "culpa" "pariatur" "id" "velit" "friends": "id": 0 "name": "Aileen Maddox" "id": 1 "name": "Garcia Mcintyre" "id": 2 "name": "Irwin Lambert" "randomArrayItem": "cherry" "id": 6 "guid": "f6d803a2-c894-4372-90c4-64a302bc0d34" "isActive": true "balance": "$2,306.00" "picture": "http://placehold.it/32x32" "age": 29 "name": "Obrien Cohen" "gender": "male" "company": "Hawkster" "email": "obriencohen@hawkster.com" "phone": "+1 (891) 564-3992" "address": "339 Harwood Place, Levant, Kansas, 6522" "about": "Proident officia amet do nisi aliquip. Fugiat non eu cupidatat fugiat amet ullamco id ut sunt consectetur. Nostrud culpa nostrud aute aliqua mollit aute. Ex reprehenderit eu cupidatat aliquip quis est eiusmod ipsum culpa sunt cillum occaecat laboris. Labore elit ut enim voluptate consequat nulla aliquip do.\r\n" "registered": "1988-10-27T06:40:24 -07:00" "latitude": 68574415 "longitude": -90802859 "tags": "consectetur" "et" "aliqua" "irure" "laborum" "veniam" "ullamco" "friends": "id": 0 "name": "Trudy Silva" "id": 1 "name": "Kathie Olsen" "id": 2 "name": "Cathy Bullock" "randomArrayItem": "cherry" Now, we can convert that JSON to key-value map:
var flattenr = ; // see above, I will not paste it again here. var objects = ".." // This time I will use / as a separator character var f = objects "/";Ok, now we can now get the data using get() method:
console;It will log:
OK. That's it
Now, I want to get value from key:
console;it will logs:
get("3/company") => Pivitol
What about find a data based on a specific key?
console;Result:
find => Or we can find very specific key value pairs, find some balance around $2,xxx:
consoleResult:
Documentation
new Flattenr(data, [separator]);
Data is a JSON object. While separator is optional, default is . (dot). But you can use your own separator to be more readable, such as / or :
Flattenr returns flatten object, f
f.get(string)
String is a path of your flat json. For example, get("6/balance")
f.find(string)
Search key or value based on regular expression from string. for example f.find("about") will returns data that contains key and value, that match the string.
It returns FlattenData. You can get the data with .get() method, for example:
var v = fvf.find({key: value})
Same as f.find() with string as argument, but it pass key-value pairs instead of string. for example:
fLicense
The MIT License (MIT)
Copyright (c) 2014 Ribhararnus Pracutiar
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.