# obdots

> Create dot-path strings of nested objects

Latest version **0.0.4** (published 2016-03-24) · MIT license · 0 weekly downloads

## Install

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

## 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.4 |
| Published | 2016-03-24 |
| First published | 2016-03-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Jason Tran |
| Maintainers | eipromb |
| Keywords | object, access, dot, path, dotty, create, string |

## Links

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

## Alternatives

- [base64url](https://npm.io/package/base64url.md) — 6.1M weekly downloads
- [get-installed-path](https://npm.io/package/get-installed-path.md) — 502.9K weekly downloads
- [@uppy/url](https://npm.io/package/@uppy/url.md) — 185.8K weekly downloads
- [@d3fc/d3fc-shape](https://npm.io/package/@d3fc/d3fc-shape.md) — 16.2K weekly downloads
- [localizer](https://npm.io/package/localizer.md) — 226 weekly downloads

## Recent versions

- 0.0.4 (latest) — 2016-03-24
- 0.0.3 — 2016-03-24
- 0.0.2 — 2016-03-24
- 0.0.1 — 2016-03-24

## README

# obdots
Create dot-path strings of nested objects

Overview
--------

Obdots generates dot-path strings of nested objects to that can be used to pass
into packages like Dotty.

Obdots was created to be used in conjunction with a package like Dotty to
simplify the setting of state in a React application.


Installation
------------

Here's a link to the [npm](https://www.npmjs.com/package/obdots) page.

	npm install obdots

Usage
-----

If an object has multiple properties at any given level, the first found is used
to generate the dot-path string.  Values are not returned in the path.  Arrays
are treated as values.

```javascript
var obdots = require("obdots");

var object = {
  a: {
    b: {
      x: "y",
    },
    c: {
      x: "z",
    },
  },
};

console.log(obdots(object)); // a.b.x
```

License
-------

MIT License. A copy is included with the source.

Contact
-------

* GitHub ([http://github.com/eipromb](eipromb))
* Email ([mailto:jason@makepigeonpie.com](jason@makepigeonpie.com))

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