npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

fp-object-transform

v2.5.0

Published

A small lib to transform object properties using sync or async functions

Downloads

1

Readme

Object Transform

Build Status npm version Dependency Status devDependency Status

Introduction:

A small library to do object transforms. Mostly for use with functional programming pipelines and streams. The arguments are 'reversed' to be able to do meaningful partial application / currying.


.transformSync(fn, object)

Transform the properties of an object based on a transform function fn

Arguments

  • fn(result, value, key) - This gets called for all properties of the object, and the result should be mutated to the desired result. No explicit return necessary.
  • object - The original object that is to be transformed.

Example

var obtr = require('fp-object-transform');

var words = {
  a: 'hello',
  b: 'world'
};

var transformed = obtr.transformSync(function(result, value, key) {
  result[key] = value.split('').reverse().join('');
}, words);
// {
//   a: 'olleh',
//   b: 'dlrow'
// }

.transformToSync(transforms, object)

Transform the properties of an object based on an object describing transforms on specific properties. The value of the property is used as input for the transform

Arguments

  • transforms - An object specifying the transforms to be applied.
  • object - The original object that is to be transformed.

Example

var obtr = require('fp-object-transform');

var reverse = function(str) {
  return str.split('').reverse().join('');
};

var words = {
  a: 'hello',
  b: 'world',
  foo: 'bar',
  bar: {
    baz: 'qux'
  }
};

var transforms = {
  a: reverse,
  b: reverse,
  bar: {
    baz: reverse
  }
};

var transformed = obtr.transformToSync(transforms, words);
// {
//   a: 'olleh',
//   b: 'dlrow',
//   foo: 'bar',
//   bar: {
//     baz: 'xuq'
//   }
// }

.copyToFrom(specs, object)

Copy object properties to new properties on the same object, with support for string literals

Arguments

  • specs - A string or an array of strings describing what to copy and where to put it.
  • object - The original object that is to be transformed.

Example

var obtr = require('fp-object-transform');

var original = {
  name: 'Eirik',
  birth: {
    year: 1986
  },
  list: [{
    count: 1
  }]
};

var specs = {
  newField: 'name',
  newField2: {
    nestedField: 'name',
    nestedField2: {
      birthYear: 'birth.year'
    }
  },
  birthYear: 'birth.year',
  firstListElement: 'list[0].count'
};

var transformed = obtr.copyToFrom(specs, original);
// { 
//   name: 'Eirik',
//   birth: { year: 1986 },
//   list: [ { count: 1 } ],
//   newField: 'Eirik',
//   newField2: { nestedField: 'Eirik', nestedField2: { birthYear: 1986 } },
//   birthYear: 1986,
//   firstListElement: 1
// }

.transform(fn, object, callback)

(Asyncronous version) Transform the properties of an object based on a transform function fn.

Arguments

  • fn(result, value, key, callback) - This gets called for all properties of the object, and the result should be mutated to the desired result. Invoke callback with an error or null when done.
  • object - The original object that is to be transformed.
  • callback(err, result) - a final callback to be called with the result or an error.

Example

var obtr = require('fp-object-transform');

var words = {
  a: 'hello',
  b: 'world'
};

obtr.transform(function(result, value, key, callback) {
  result[key] = value.split('').reverse().join('');
  callback();
}, words, function(err, transformed) {
  console.log(transformed);
  // {
  //   a: 'olleh',
  //   b: 'dlrow'
  // }
});

.transformTo(transforms, object)

(Asyncronous version) Transform the properties of an object based on an object describing transforms on specific properties. The value of the property is used as input for the transform.

Arguments

  • transforms - An object specifying the transforms to be applied.
  • object - The original object that is to be transformed.
  • callback(err, result) - a final callback to be called with the result or an error.

Example

var obtr = require('fp-object-transform');

var reverse = function(input, callback) {
  callback(null, input.split('').reverse().join(''));
}

var words = {
  a: 'hello',
  b: 'world',
  foo: 'bar',
  bar: {
    baz: 'qux'
  }
};

var transforms = {
  a: reverse,
  b: reverse,
  bar: {
    baz: reverse
  }
};

obtr.transformTo(transforms, words, function(err, transformed) {
  console.log(transformed);
  // {
  //   a: 'olleh',
  //   b: 'dlrow',
  //   foo: 'bar',
  //   bar: {
  //     baz: 'xuq'
  //   }
  // }
});

.deriveToSync(derivatives, object)

Transform the properties of an object based on an object describing transforms on specific properties. The value of the property is used as input for the transform

This is really just a shorthand for doing .copyToFrom and .transformToSync in sequence.

Arguments

  • derivatives - An object specifying the derivatives to be applied.
  • object - The original object that is to be transformed.

Example

var obtr = require('fp-object-transform');

var reverse = function(str) {
  return str.split('').reverse().join('');
};

var words = {
  a: 'hello',
  b: 'world',
  foo: 'bar',
  bar: {
    baz: 'qux'
  }
};

var derivatives = {
  b: ['b', reverse];
  newField: ['bar.baz', reverse],
};

var transformed = obtr.deriveToSync(derivatives, words);
// {
//   a: 'hello',
//   b: 'dlrow',
//   foo: 'bar',
//   bar: {
//     baz: 'qux'
//   },
//   newField: 'xuq'
// }

.deriveTo(derivatives, object)

(Asynchronous version) Transform the properties of an object based on an object describing transforms on specific properties. The value of the property is used as input for the transform

This is really just a shorthand for doing .copyToFrom and .transformTo in sequence.

Arguments

  • derivatives - An object specifying the derivatives to be applied.
  • object - The original object that is to be transformed.

Example

var obtr = require('fp-object-transform');

var reverse = function(input, callback) {
  callback(null, input.split('').reverse().join(''));
}

var words = {
  a: 'hello',
  b: 'world',
  foo: 'bar',
  bar: {
    baz: 'qux'
  }
};

var transforms = {
  b: ['b', reverse];
  newField: ['bar.baz', reverse],
};

obtr.deriveTo(transforms, words, function(err, transformed) {
  console.log(transformed);
  // {
  //   a: 'hello',
  //   b: 'dlrow',
  //   foo: 'bar',
  //   bar: {
  //     baz: 'qux'
  //   },
  //   newField: 'xuq'
  // }
});