# properties-mapper

> This utility helps convert one JSON object with it's own properties to another specifing target properties

Latest version **0.1.1** (published 2017-03-18) · MIT license · 0 weekly downloads

## Install

```sh
npm install properties-mapper
pnpm add properties-mapper
yarn add properties-mapper
bun add properties-mapper
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.1 |
| Published | 2017-03-18 |
| First published | 2017-03-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | SSharyk |
| Maintainers | ssharyk |
| Keywords | JSON, mapper, property, properties, convertation |

## Links

- npm: https://www.npmjs.com/package/properties-mapper
- Repository: https://github.com/SSharyk/properties-mapper
- Homepage: https://github.com/SSharyk/properties-mapper#readme
- Issues: https://github.com/SSharyk/properties-mapper/issues
- npm.io page: https://npm.io/package/properties-mapper

## Alternatives

- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads

## Recent versions

- 0.1.1 (latest) — 2017-03-18
- 0.1.0 — 2017-03-15

## README

# Properties mapper Node.js package
JSON Objects convertation utility

## Summary
_Version_: 0.1.1

_Usage_: anywhere you need to rename your objects' properties

## Description
The utility allows you to rename properties of JSON objects in one line of code. The source object is immutable and new one (with properties you need) is created.


## How to use
1. To install the package, type `npm install properties-mapper` in prompt.
2. Use `require('properties-mapper')` to import the functionality.
3. The package contains the only function `map` that takes 4 arguments as an input:
  * `Object` which you want to convert
  * `source` is either a comma-separated string or array that contains properties' names that should be renamed
  * `target` is either a comma-separated string or array too that contains appropriate properties' names for result object
  * `isRecursive` flag (optional, `true` is default) which is set if the function should be called recursively for each nested object
4. The function returns new object with renamed properties and stored appropriate values.


## Example
```
// Import 
var map = require('properties-mapper');

// Create test object and convertion options
let book = {
	Title: "Stories",
	Description: "The book contains well-known stories of Lev Tolstoy",
	Author: {
		FirstName: "Lev",
		LastName: "Tolstoy"
	},
	Pages: 57,
	Year: 1998
};
let source = "Title, Description, Author, FirstName, LastName, Pages, Year";
let target = "title, description, author, firstName, lastName, pages, year";

// Convert it
let preparedBook = map.map(book, source, target);

```
Result is:
```
{ 
  title: 'Stories',
  description: 'The book contains well-known stories of Lev Tolstoy',
  author: { 
    firstName: 'Lev', 
    lastName: 'Tolstoy' 
  },
  pages: 57,
  year: 1998 
}
```

---
_Source: https://npm.io/package/properties-mapper · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._