# deindex

> Flatten an object with `index` keys

Latest version **1.0.0** (published 2016-08-12) · MIT license · 0 weekly downloads

## Install

```sh
npm install deindex
pnpm add deindex
yarn add deindex
bun add deindex
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2016-08-12 |
| First published | 2016-08-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Ben Drucker |
| Maintainers | bendrucker |
| Keywords | index, flatten, traverse |

## Links

- npm: https://www.npmjs.com/package/deindex
- Repository: https://github.com/bendrucker/deindex
- Homepage: https://github.com/bendrucker/deindex#readme
- Issues: https://github.com/bendrucker/deindex/issues
- npm.io page: https://npm.io/package/deindex

## Dependencies (1)

- [traverse](https://npm.io/package/traverse.md) ~0.6.6

## Recent versions

- 1.0.0 (latest) — 2016-08-12

## README

# deindex [![Build Status](https://travis-ci.org/bendrucker/deindex.svg?branch=master)](https://travis-ci.org/bendrucker/deindex)

> Flatten an object with `index` keys

Useful for representing modular folder structures with `index.*` files as the "main" file in a proper tree.

## Install

```
$ npm install --save deindex
```


## Usage

```js
var deindex = require('deindex')

deindex({foo: {bar: {index: 'baz'}}})
//=> {foo: {bar: 'baz'}}
```

## API

#### `deindex(obj)` -> `object`

##### obj

*Required*  
Type: `object`

Traverses the object and returns a new object with lone `index` keys flattened out.


## License

MIT © [Ben Drucker](http://bendrucker.me)

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