transformer-response-data v1.0.1

transformer-response-data

Install

npm install transformer-response-data --save

Test

npm test

Basic Usage

//import library
var Transformer = require('transformer-response-data');

//get data from database or ...
var dataDatabase = {
    "_id": "5a91c4547886436ed94e6326",
    "firstName": "John",
    "lastName": "Doe",
    "password": "$2a$10$VzJQsmaknGuafqXSfzDWg.zPshX..uY26Yn8X9TJnvjGqHex1FQ7S",
};

//create transformer and define output properties
var userTransformer = new Transformer({
    "id": "_id",
    "name": function (data) {
        return data.firstName + " " + data.lastName;
    }
});

//transform data
var dataTransformed = userTransformer.transformer(dataDatabase);
console.log(dataTransformed);

The expected output

{  
   "id": "5a91c4547886436ed94e6326",
   "name": "John Doe"
}

Usage with others transformers

//import library
var Transformer = require('transformer-response-data');

//get data from database or ...
var dataDatabase = {
    "_id": "5a91c4547886436ed94e6326",
    "firstName": "John",
    "lastName": "Doe",
    "password": "$2a$10$VzJQsmaknGuafqXSfzDWg.zPshX..uY26Yn8X9TJnvjGqHex1FQ7S",
    "role" : {
      "_id" : "5a93080d13592753b1146198",
      "name" : "admin",
      "permission" : 5
    }
};

//create transformer and define output properties
var userTransformer = new Transformer({
    "id": "_id",
    "name": function (data) {
        return data.firstName + " " + data.lastName;
    },
    "role" : {
      "field" : "role", //it identify the property in data from server
      "reference" : new Transformer({
            "id": "_id",
            "name": "name"
        })
    }
});

//transform data
var dataTransformed = userTransformer.transformer(dataDatabase);
console.log(dataTransformed);

The expected output

{  
   "id": "5a91c4547886436ed94e6326",
   "name": "John Doe",
   "role": {  
      "id": "5a93080d13592753b1146198",
      "name": "admin"
   }
}

Usage with data arrays

//import library
var Transformer = require('transformer-response-data');

//get data from database or ...
var dataDatabase = {
    "_id": "5a91c4547886436ed94e6326",
    "firstName": "John",
    "lastName": "Doe",
    "password": "$2a$10$VzJQsmaknGuafqXSfzDWg.zPshX..uY26Yn8X9TJnvjGqHex1FQ7S",
    "role" : {
      "_id" : "5a93080d13592753b1146198",
      "name" : "admin",
      "permission" : 5
    },
    "permissions" : [
      {
        "_id" : "5a9307b413592753b1146197",
        "name" : "create"
      },
      {
        "_id" : "5a93076510c0b653673e7264",
        "name" : "delete"
      }
    ]
};

//create transformer and define output properties
var userTransformer = new Transformer({
    "id": "_id",
    "name": function (data) {
        return data.firstName + " " + data.lastName;
    },
    "role" : {
      "field" : "role", //it identify the property in data from server
      "reference" : new Transformer({
            "id": "_id",
            "name": "name"
        })
    },
    "permissions": {
        "field": "permissions",
        "reference": new Transformer({
            "name_permission": "name"
        })
    }
});

//transform data
var dataTransformed = userTransformer.transformer(dataDatabase);
console.log(dataTransformed);

The expected output

{  
   "id":"5a91c4547886436ed94e6326",
   "name":"John Doe",
   "role":{  
      "id":"5a93080d13592753b1146198",
      "name":"admin"
   },
   "permissions":[  
      {  
         "name_permission":"create"
      },
      {  
         "name_permission":"delete"
      }
   ]
}

Usage when data is a array

//import library
var Transformer = require('transformer-response-data');

//get data from database or ...
var dataDatabase = [
  {
    "_id": "5a91c4547886436ed94e6326",
    "firstName": "John",
    "lastName": "Doe",
    "password": "$2a$10$VzJQsmaknGuafqXSfzDWg.zPshX..uY26Yn8X9TJnvjGqHex1FQ7S",
  },
  {
    "_id": "5a931bd3bac34d6aa90804dc",
    "firstName": "Homero",
    "lastName": "Simpson",
    "password": "$2a$10$B19Xg/peAH.BK4Z1gV/xJ.2OXvm9kO95W89SYzAxYP7GS26i9mOvy",
  }
];

//create transformer and define output properties
var userTransformer = new Transformer({
    "id": "_id",
    "name": function (data) {
        return data.firstName + " " + data.lastName;
    }
});

//transform data
var dataTransformed = userTransformer.transformer(dataDatabase);
console.log(dataTransformed);

The expected output

[  
   {  
      "id":"5a91c4547886436ed94e6326",
      "name":"John Doe"
   },
   {  
      "id":"5a931bd3bac34d6aa90804dc",
      "name":"Homero Simpson"
   }
]

License

MIT © Jhon Freddy Rondon