# undefsafe

> Undefined safe way of extracting object properties

Latest version **2.0.5** (published 2021-10-17) · MIT license · 0 weekly downloads

## Install

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

## 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 | 2.0.5 |
| Published | 2021-10-17 |
| First published | 2014-01-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 7.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 72 |
| Author | Remy Sharp |
| Maintainers | remy |
| Keywords | undefined |

## Links

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

## Recent versions

- 2.0.5 (latest) — 2021-10-17
- 2.0.3 — 2020-02-17
- 2.0.2 — 2018-02-15
- 2.0.1 — 2017-02-21
- 2.0.0 — 2017-02-12
- 1.3.1 — 2017-02-08
- 1.3.0 — 2017-02-08
- 1.2.0 — 2016-08-23
- 1.1.0 — 2016-04-13
- 1.0.0 — 2016-01-29
- 0.0.3 — 2015-04-13
- 0.0.2 — 2014-01-14
- 0.0.1 — 2014-01-08

## README

# undefsafe

Simple *function* for retrieving deep object properties without getting "Cannot read property 'X' of undefined"

Can also be used to safely set deep values.

## Usage

```js
var object = {
  a: {
    b: {
      c: 1,
      d: [1,2,3],
      e: 'remy'
    }
  }
};

console.log(undefsafe(object, 'a.b.e')); // "remy"
console.log(undefsafe(object, 'a.b.not.found')); // undefined
```

Demo: [https://jsbin.com/eroqame/3/edit?js,console](https://jsbin.com/eroqame/3/edit?js,console)

## Setting

```js
var object = {
  a: {
    b: [1,2,3]
  }
};

// modified object
var res = undefsafe(object, 'a.b.0', 10);

console.log(object); // { a: { b: [10, 2, 3] } }
console.log(res); // 1 - previous value
```

## Star rules in paths

As of 1.2.0, `undefsafe` supports a `*` in the path if you want to search all of the properties (or array elements) for a particular element.

The function will only return a single result, either the 3rd argument validation value, or the first positive match. For example, the following github data:

```js
const githubData = {
        commits: [{
          modified: [
            "one",
            "two"
          ]
        }, /* ... */ ]
      };

// first modified file found in the first commit
console.log(undefsafe(githubData, 'commits.*.modified.0'));

// returns `two` or undefined if not found
console.log(undefsafe(githubData, 'commits.*.modified.*', 'two'));
```

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