# property-path

> Get and set object properties by path where you can specify the separator.

Latest version **1.0.0** (published 2019-03-19) · MIT license · 0 weekly downloads

## Install

```sh
npm install property-path
pnpm add property-path
yarn add property-path
bun add property-path
```

## 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 | 2019-03-19 |
| First published | 2014-01-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 16.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Edmond Meinfelder |
| Maintainers | stdarg |
| Keywords | object, property, obj, properties, path, get, set, paths, pathes, string, separator |

## Links

- npm: https://www.npmjs.com/package/property-path
- Repository: https://github.com/stdarg/property-path
- Issues: https://github.com/stdarg/property-path/issues
- npm.io page: https://npm.io/package/property-path

## Dependencies (2)

- [is2](https://npm.io/package/is2.md) 2.0.1
- [lodash.filter](https://npm.io/package/lodash.filter.md) 4.6.0

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

- 1.0.0 (latest) — 2019-03-19
- 0.0.7 — 2019-03-19
- 0.0.6 — 2019-03-19
- 0.0.5 — 2014-01-31
- 0.0.4 — 2014-01-31
- 0.0.3 — 2014-01-16
- 0.0.2 — 2014-01-16
- 0.0.1 — 2014-01-16

## README

property-path
=============

Get and set object properties by a string path, where you can specify the
separator.

## Example

    var propPath = require('property-path');

    var testObj = {
        a: 1,
        b: true,
        c: {
            d: {
                e: 'Hello',
                f: [ 1, 2, false, 'hi' ]
            }
        }
    };

    console.log(propPath.get(testObj, 'a'));
    console.log(propPath.get(testObj, 'b'));
    console.log(propPath.get(testObj, 'c.d.e'));
    console.log(propPath.get(testObj, 'c/d/e', '/'));

    propPath.set(testObj, 'c.d.f.0', 333);
    console.log(testObj.c.d.f[0]);

The above code results in the following output:

    1
    true
    Hello
    Hello
    333

## Installation

    npm install property-path

## API

### get(obj, path, [sep])

Given an object and a char-separated path, return the value at the path
or false if no such value can be found.

#### Params: 

* **Object** *obj* An object upon which to apply the path.
* **String** *path* The path to traverse the object, e.g 'a.b.c'
* **String** *[sep]* The separator char to delimit the properties in the path. Optional. If not specified, '.' is assumed.

#### Return:

* **Undefined|Any** returns the value, if found or undefined otherwise.

### set(obj, path, value, [sep])

Given an object and a char-separated path, return the value at the path
or false if no such value can be found.

#### Params: 

* **Object** *obj* An object upon which to apply the path.
* **String** *path* The path to traverse the object, e.g 'a.b.c'
* **Any** *value* The value to set the property to.
* **String** *[sep]* The separator char to delimit the properties in the path. Optional. If not specified, '.' is assumed.

#### Return:

* **Undefined|Any** returns the value set, if the property is found or undefined otherwise.

### remove(obj, path, [sep])
Delete the property at path on obj.

* **Object** *obj* An object upon which to apply the path.
* **String** *path* The path to traverse the object, e.g 'a.b.c'
* **String** *[sep]* The separator char to delimit the properties in the path. Optional. If not specified, '.' is assumed.

#### Return:

* **Boolean** returns the value set, if the property is found or undefined otherwise.

### setSepChar(chr)
Set the default separator character. Normally, when not specified, '.' is used,
however, you may set the default to whatever you want.

* **String** *chr* The new default separator char to delimit the properties in the path.

#### Return:

* **Boolean** true if set and false otherwise.


## License
The MIT License (MIT)

Copyright (c) 2014 Edmond Meinfelder

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

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