https://github.com/with-heart/evolve-evolved

A library for efficiently mapping objects from one type to another.
https://github.com/with-heart/evolve-evolved

fp javascript mapper mapping ramda typescript

Last synced: 5 months ago
JSON representation

A library for efficiently mapping objects from one type to another.

• Host: GitHub
• URL: https://github.com/with-heart/evolve-evolved
• Owner: with-heart
• Archived: true
• Created: 2019-08-08T16:59:27.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2021-05-25T12:56:59.000Z (about 4 years ago)
• Last Synced: 2024-10-02T08:59:14.321Z (9 months ago)
• Topics: fp, javascript, mapper, mapping, ramda, typescript
• Language: TypeScript
• Homepage:
• Size: 813 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 8
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# evolve-evolved

A library for efficiently mapping objects from one type to another. Based in part on the concept behind [`ramda.evolve`](https://ramdajs.com/docs/#evolve).

```ts

import { evolve, rename, remove } from 'evolve-evolved'

import { compose, toUpper, head, append } from 'ramda'

const from = {

  a: 'hello',

  b: true,

  c: 'life is swell',

  d: {

    e: ['first'],

  },

  f: 'bye-bye',

  y: 'i am y',

}

const apply = evolve({

  a: toUpper,

  b: 'now a string',

  c: rename(

    'z',

    compose(

      toUpper,

      head,

    ),

  ),

  d: {

    e: append('last'),

  },

  f: remove,

  x: toUpper, // not applied, because it doesn't exist in the object

})

apply(from) ===

  {

    // transformed by `toUpper`

    a: 'HELLO',

    // replaced by raw value

    b: 'now a string',

    // appended value to d.e

    d: {

      e: ['first', 'last'],

    },

    // f: 'bye-bye' // removed from the final object by `remove`

    // no transformation provided, so passed straight through

    y: 'i am y',

    // renamed from `c` key to `z` key by `rename`

    // value transformed by `toUpper` and `head`

    z: 'L',

  }

```

# Why?

Mapping objects in a modern frontend project can be tiresome. Small variations of object types tend to exist between the various layers of the application (backends, APIs, form values, etc.). For complex types, this leads to large mapping functions, with many paths of branching logic, simply to

`evolve-evolved` allows you to apply an object of transformations to an object, transforming the entire shape of the object at once.