sha
shapify
npm i shapify
sha

shapify

🌀Easily transform objects/rename keys with full TypeScript support

by Eduardo San Martin Morote

1.1.0 (see all)License:MITTypeScript:Built-In
npm i shapify
Readme

shapify Build Status npm package coverage thanks

Easily reshape objects with TS support

Installation

npm install shapify
# or
yarn install shapify

Usage

Basic usage

Given an array of users:

const users = [
  { fullname: 'Eduardo San Martin morote', id: 1, more: 'properties', that: 'exist', but: "you don't always need"]},
  // more users
]

You can transform objects

import { shapify } from 'shapify'

const reshapedUser = shapify(
  {
    text: 'fullname',
    value: 'id',
  },
  users[0]
)
/**
 * only text and value are present
 * { text: 'Eduardo San Martin Morote', value: 1 }
 */

Functional approach

This can be used to transform whole arrays of objects:

import { shapify, shaper } from 'shapify'
// create a function with the first parameter fixed
const userShaper = shaper({ text: 'fullname', value: 'id' })
// equivalent to
const sameUserShaper = shapify.bind(null, { text: 'fullname', value: 'id' })

// generate the new array
const userChoices = users.map(userShaper)

⚠️: (#3) this breaks typings (mark them as unknown), if you know how to make it work, please file a PR

Customizing the new value

If you want to customize the value instead of just using the original one, you can provide a function:

const reshapedUser = shapify(
  {
    text: 'fullname',
    value: user => 'id: ' + user.id,
  },
  users[0]
)
/**
 * only text and value are present
 * { text: 'Eduardo San Martin Morote', value: 'id: 1' }
 */

Keeping original keys/values

If you need to keep original keys, you can provide a key with the same value:

shapify({ id: 'id' }, users[0])

But a more appropriate syntax is an array of keys (strings, numbers or symbols):

shapify(['id', 'fullname'], users[0])

This is similar to lodash.pick(users[0], ['id', 'fullname']). However, because shapify is type safe, it cannot support paths as strings as lodash.pick does. Instead you need to use a function.

If you need to keep all of the original keys, there is a helper that you can use:

import { shapify, keepKeys } from 'shapify'

// this will generate a user object with all of the original properties as well
// as text with fullname's value
shapify(
  {
    ...keepKeys(users[0]),
    text: 'fullname',
  },
  users[0]
)

License

MIT

Downloads/wk

2

GitHub Stars

65

LAST COMMIT

7mos ago

MAINTAINERS

1

CONTRIBUTORS

6

OPEN ISSUES

2

OPEN PRs

2
VersionTagPublished
1.1.0
latest
4yrs ago
No alternatives found
No tutorials found
Add a tutorial
No dependencies found

Rate & Review

100
No reviews found
Be the first to rate