1.0.2 • Published 2 years ago

flat-the-object v1.0.2

Weekly downloads
-
License
ISC
Repository
github
Last release
2 years ago

Flat the object

The purpose of the package is to convert the nested object into faltten object

Installation

$ npm install flat-the-object

Example

This is the practical example of how to use

const getFlattenObject = require('flat-the-object')

const user = {
    name: "Your Name",
    address: {
        personal: {
            city: "NY",
            state: "WX",
            coordinates: {
                x: 35.12,
                y: -21.49,
            },
        },
    },
    contact: {
        phone: {
            home: "xxx",
            office: "yyy",
        },
        email: {
            home: "xxx",
            office: "yyy"
        },
    },
};

//convert the object by passing the object in the function
//there are 2 parameters 
//1. the actual object
//2. give the name and object key will start with that name

console.log(getFlattenObject(user, "data"));

// result will be like this:
// {
//   data_name: 'Your Name',
//   data_address_personal_city: 'NY',
//   data_address_personal_state: 'WX',
//   data_address_personal_coordinates_x: 35.12,
//   data_address_personal_coordinates_y: -21.49,
//   data_contact_phone_home: 'xxx',
//   data_contact_phone_office: 'yyy',
//   data_contact_email_home: 'xxx',
//   data_contact_email_office: 'yyy'
// }