trainsform

node-trainsform

Trainsform a object to the others:

set and delete

simple example:

var trainsform = require('trainsform')();
trainsform
  .set('key', 'value');
  
var ret = trainsfom({});   // ret - { key: 'value' }


trainsform
  .set('a.b', 1);

ret = trainsfom({});       // ret - { key: 'value', a: { b: 1 }}

callback example:

var trainsform = require('trainsform')();

trainsform
  .set('result', function(wrapped) {
    return wrapped.get('a') + wrapper.get('b');
  })
  .delete('a', 'b');

var origin = {
  a: 1,
  b: 2
};

var result = trainsform(origin);

// then result will be { result: 3 }

alias

var trainsform = require('trainsform')();
trainsform
  .alias('name', 'as');
  
var origin = { name: 'foo' };
var ret = trainsform(origin);  // ret - { name: 'foo', as: 'foo' }

rename

simple rename example

var trainsform = require('trainsform')();

trainsform
  .rename('foo', 'bar');
  
var ret = trainsform({ foo: 'foo'});  // ret - { bar: 'foo' }

rename with callback

var trainsform = require('trainsform')();

trainsform
  .rename('foo', 'bar', function(value) {
    return value + ' bar';
  });

var ret = trainsform({ foo: 'foo'});  // ret - { bar: 'foo bar' }

function side effects

var trainsform = require('trainsform')(),
    rename = trainsform.rename('a', 'a.b.c'),
    alias = trainsform.alias('a', 'b');

console.log(rename === alias); // false