json-ripper v1.0.9

json-ripper

This library allows you to make queries, to turn json nested data into relational data.

To install it you can run

npm i json-ripper

then import it like this

import jsonRipper from "json-ripper"

Lets say you have a javascript object:

const obj = [
    {
        "Id": 0,
        "Name":"Jhon doe",
        "Age": 39,
        "Occupations":[
            "Programmer",
            "Design"
        ]
    },
    {
        "Id": 1,
        "Age": 25,
        "Name":"Mary",
        "Occupations":[
            "Nurse",
        ]
    },
    {
        "Id": 3,
        "Name":"Lucy",
        "Occupations":[
            "Student",
        ]
    }
]

You can do this query recover some data from it:

const query = [
    "*/Id:IdUser",
    "*/Occupations/*:Occupation",
]

const userOccupations = jsonRipper(obj, query)

console.log(userOccupations)

That will result on this output:

[
    {
        "IdUser": 0,
        "Occupation": "Programmer"
    },
    {
        "IdUser": 0,
        "Occupation": "Design"
    },
    {
        "IdUser": 1,
        "Occupation": "Nurse"
    },
    {
        "IdUser": 3,
        "Occupation": "Student"
    }
]

here is another example

const query = [
    "*/Id:IdUser",
    "*/Name",
    "?*/Age",
]
const users = jsonRipper(obj, query)

[
    {
        "IdUser": 0,
        "Name": "Jhon doe",
        "Age": 39
    },
    {
        "IdUser": 1,
        "Name": "Mary",
        "Age": 25
    },
    {
        "IdUser": 3,
        "Name": "Lucy"
    }
]

The structure is pretty simple.

The jsonRipper method receives two parameters, an object and a query.

The query parameter is an array of patterns, that all non optional must be fulfilled to the object be added in the result.

The pattern consists of

"any text": a key to be matched in a object
"*": a array to be matched in the object
":": optional paramter, at the end, that is a alias for the column
"?": if the fist character is a interrogation, the match is optional