# deep-lib

> Enables to manipulate data and its substructures using dot separated property paths and methods to create, update, delete, select, move, search, check equality, check diff, ...

Latest version **1.1.0** (published 2015-11-06) · MIT license · 0 weekly downloads

## Install

```sh
npm install deep-lib
pnpm add deep-lib
yarn add deep-lib
bun add deep-lib
```

## 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.1.0 |
| Published | 2015-11-06 |
| First published | 2015-09-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | https://github.com/CoderSyndicate/deep-lib/graphs/contributors |
| Maintainers | luscus |
| Keywords | object, deep, data, structure, add, move, delete, equal, clone, diff, get, manipulation |

## Links

- npm: https://www.npmjs.com/package/deep-lib
- Repository: https://github.com/CoderSyndicate/deep-lib
- Issues: https://github.com/CoderSyndicate/deep-lib/issues
- npm.io page: https://npm.io/package/deep-lib

## Dependencies (3)

- [clone](https://npm.io/package/clone.md) *
- [deep-diff](https://npm.io/package/deep-diff.md) *
- [deep-equal](https://npm.io/package/deep-equal.md) *

## Alternatives

- [gamedig](https://npm.io/package/gamedig.md) — 29.3K weekly downloads
- [join-monster](https://npm.io/package/join-monster.md) — 12.8K weekly downloads
- [masked](https://npm.io/package/masked.md) — 5.5K weekly downloads
- [@comunica/actor-query-process-explain-logical](https://npm.io/package/@comunica/actor-query-process-explain-logical.md) — 4.7K weekly downloads
- [@veracity/vui](https://npm.io/package/@veracity/vui.md) — 4.6K weekly downloads

## Recent versions

- 1.1.0 (latest) — 2015-11-06
- 1.0.0 — 2015-10-07
- 0.0.4 — 2015-09-21
- 0.0.3 — 2015-09-16
- 0.0.2 — 2015-09-16
- 0.0.1 — 2015-09-15

## README

# deep-lib

[![NPM version](https://img.shields.io/npm/v/deep-lib.svg?style=flat)](https://www.npmjs.com/package/deep-lib "View this project on NPM")
[![NPM downloads](https://img.shields.io/npm/dm/deep-lib.svg?style=flat)](https://www.npmjs.com/package/deep-lib "View this project on NPM")
[![NPM license](https://img.shields.io/npm/l/deep-lib.svg?style=flat)](https://www.npmjs.com/package/deep-lib "View this project on NPM")
[![flattr](https://img.shields.io/badge/flattr-donate-yellow.svg?style=flat)](http://flattr.com/thing/3817419/luscus-on-GitHub)

![coverage](https://rawgit.com/CoderSyndicate/deep-lib/master/reports/coverage.svg)
[![David](https://img.shields.io/david/CoderSyndicate/deep-lib.svg?style=flat)](https://david-dm.org/CoderSyndicate/deep-lib)
[![David](https://img.shields.io/david/dev/CoderSyndicate/deep-lib.svg?style=flat)](https://david-dm.org/CoderSyndicate/deep-lib#info=devDependencies)

Enables to manipulate data and its substructures using dot separated property paths and
methods to create, update, delete, select, move, search, check equality, check diff, ... (see [API.md](API.md))


## Installation

### Node Dependency

Execute following line

    npm install deep-lib --save

## Usage

All provided methods accept a `path` and/or an `offset` arguments referencing some substructure or value in the data.

- If `path` is provided, it references the object that will be processed.
- If `offset` is provided, it sets the root point in the object for the resolving of the `path` argument.

The full API documentation can be found in the [API.md](API.md)

    var deep = require('deep-lib');
    var a    = {foo: {hello: 'world'}, some: 'thing'};
    
    deep.select(a);                 // => {foo: {hello: 'world'}, some: 'thing'};
    deep.select(a, 'foo');          // => {hello: 'world'}
    deep.select(a, 'foo.hello');    // => 'world'
    deep.select(a, 'foo.bad');      // => undefined
    
    // with offset
    deep.select(a, 'hello', 'foo'); // => 'world'


-------------------
Copyright (c) 2015 Luscus (luscus.redbeard@gmail.com)

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/deep-lib · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
