# format-obj

> Formats an object

Latest version **0.0.1** (published 2015-07-03) · 0 weekly downloads

## Install

```sh
npm install format-obj
pnpm add format-obj
yarn add format-obj
bun add format-obj
```

## 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.0.1 |
| Published | 2015-07-03 |
| First published | 2015-07-03 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Enigma Marketing |
| Maintainers | relvao |

## Links

- npm: https://www.npmjs.com/package/format-obj
- Repository: https://github.com/enigmamarketing/format-obj
- Homepage: https://github.com/enigmamarketing/format-obj#readme
- Issues: https://github.com/enigmamarketing/format-obj/issues
- npm.io page: https://npm.io/package/format-obj

## Dependencies (1)

- [object-mapper](https://npm.io/package/object-mapper.md) 1.0.0

## Recent versions

- 0.0.1 (latest) — 2015-07-03

## README

# format-obj
This module is part of the [Lackey CMS](http://lackey.io).

The modules helps in converting the object key names and selecting a subset of properties. 
If data is an array the mapping will affect every item

## Install

``` 
npm install format-obj
```

## Usage

```
var formatter = require('format-obj'),
	obj;

obj = formatter({
	_id: 123,
	title: 'OK',
	test: 456
}, '_id:id title');

// returns 
// {
//    id: 123,
//    title: 'OK'
// }
```

Using the * character 

```
var formatter = require('format-obj'),
	obj;

obj = formatter({
	_id: 123,
	title: 'OK',
	test: 456
}, '_id:id *');

// returns 
// {
//    id: 123,
//    title: 'OK',
//    test: 456
// }
```

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