# js-dot

> JavaScript dot notation handler

Latest version **1.0.1** (published 2020-12-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install js-dot
pnpm add js-dot
yarn add js-dot
bun add js-dot
```

## Health

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

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2020-12-28 |
| First published | 2020-12-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 14.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Author | Jonathan Irhodia |
| Maintainers | elcharitas |
| Keywords | js, dot, js-dot, notation, object, json |

## Links

- npm: https://www.npmjs.com/package/js-dot
- Repository: https://github.com/elcharitas/js-dot
- Homepage: https://github.com/elcharitas/js-dot#readme
- Issues: https://github.com/elcharitas/js-dot/issues
- npm.io page: https://npm.io/package/js-dot

## 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

- 1.0.1 (latest) — 2020-12-28
- 1.0.0 — 2020-12-28

## README

<h1 align="center">Welcome to js-dot 👋</h1>
<p>
  <img alt="Version" src="https://img.shields.io/badge/version-1.0.0-blue.svg?cacheSeconds=2592000" />
  <a href="https://github.com/elcharitas/js-dot#readme" target="_blank">
    <img alt="Documentation" src="https://img.shields.io/badge/documentation-yes-brightgreen.svg" />
  </a>
  <a href="https://github.com/elcharitas/js-dot/graphs/commit-activity" target="_blank">
    <img alt="Maintenance" src="https://img.shields.io/badge/Maintained%3F-yes-green.svg" />
  </a>
  <a href="https://github.com/elcharitas/js-dot/blob/master/LICENSE" target="_blank">
    <img alt="License: MIT" src="https://img.shields.io/github/license/elcharitas/js-dot" />
  </a>
  <a href="https://twitter.com/elcharitas" target="_blank">
    <img alt="Twitter: elcharitas" src="https://img.shields.io/twitter/follow/elcharitas.svg?style=social" />
  </a>
</p>

> JavaScript dot notation handler

### 🏠 [Homepage](https://github.com/elcharitas/js-dot#readme)

## Install

```sh
$ npm i -D js-dot
```

## Usage

```js
const jsDot = require('jsdot')

const data = {
  foo: {
    "bar": {
      "sample": "jsDot"
    }
  }
}

// ======== Get Data ========
jsDot.get(data, "foo.bar.sample") // outputs "jsDot"
// ---- or -----
data.dot("foo.bar.sample") // outputs "jsDot"

// ======== Get Data with default ========
jsDot.get(data, "foo.nofoo", "foo") // outputs "foo"

// ======== Set Data ========
jsDot.set(data, "foo.bar", "bar")
// ----- or ------
data.dot("foo.bar", "bar")
console.log(data.foo.bar.sample) // undefined

```

## Author

👤 **Jonathan Irhodia**

* Website: elcharitas.com.ng
* Twitter: [@elcharitas](https://twitter.com/elcharitas)
* Github: [@elcharitas](https://github.com/elcharitas)

## 🤝 Contributing

Contributions, issues and feature requests are welcome!<br />Feel free to check [issues page](https://github.com/elcharitas/js-dot/issues). You can also take a look at the [contributing guide](https://github.com/elcharitas/js-dot/blob/master/CONTRIBUTING.md).

## Show your support

Give a ⭐️ if this project helped you!

## 📝 License

Copyright © 2020 [Jonathan Irhodia](https://github.com/elcharitas).<br />
This project is [MIT](https://github.com/elcharitas/js-dot/blob/master/LICENSE) licensed.

***

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