# object-getvalue

> Get Object's nested value

Latest version **1.1.0** (published 2018-02-21) · MIT license · 0 weekly downloads

## Install

```sh
npm install object-getvalue
pnpm add object-getvalue
yarn add object-getvalue
bun add object-getvalue
```

## 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 | 2018-02-21 |
| First published | 2017-03-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 90.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Ravi Roshan |
| Maintainers | raviroshan |
| Keywords | Object, getValues, getProperty |

## Links

- npm: https://www.npmjs.com/package/object-getvalue
- Repository: https://github.com/raviroshan/object-getvalue
- Homepage: https://github.com/raviroshan/object-getvalue#readme
- Issues: https://github.com/raviroshan/object-getvalue/issues
- npm.io page: https://npm.io/package/object-getvalue

## Recent versions

- 1.1.0 (latest) — 2018-02-21
- 1.0.5 — 2017-04-14
- 1.0.4 — 2017-03-31
- 1.0.3 — 2017-03-30
- 1.0.2 — 2017-03-30
- 1.0.1 — 2017-03-30
- 1.0.0 — 2017-03-30

## README

# object-getvalue [(npm-link)](https://www.npmjs.com/package/object-getvalue)

Get the Object's property directly including nested properties.
It supports the default return value and hasOwnProperty check.

[![Build Status](https://travis-ci.org/raviroshan/object-getvalue.svg?branch=master)](https://travis-ci.org/raviroshan/object-getvalue)
[![license](https://img.shields.io/github/license/mashape/apistatus.svg?style=plastic)](#)
[![Gemnasium](https://img.shields.io/gemnasium/mathiasbynens/he.svg)](#)

Runtime Error occurs when any key in the sequence is undefined while getting the Object's nested property value.
> person.address.location.current.city

To Avoid that, it's best practise to check for each property on object in sequence
```js
if (person.address &&
	person.address.location &&
	person.address.location.current &&
	person.address.location.current.city) {

	// var city = person.address.location.current.city

}
```

This package helps you in directly getting the nested property value from the Object
> getValue(person, 'address.location.current.city')   //=> 'Bangalore'


You can use it to avoid ternary operation while fetching the Object value and assigning that to a variable without worrying about any run-time error.

```js
// Traditional way
var city = person.address.location.current.city ? person.address.location.current.city : 'Bangalore';

// Cleaner & Safe way - using getValue()
var city = getValue(person, 'address.location.current.city', 'Bangalore');
```

## Installation

```sh
npm install object-getvalue --save
```

## Usage

### Arguments

1. `object` (Object) The object to query
2. `property` (String) Simple or Nested property
3. (Optional) `defaultValue` (any) The value returned ONLY if property value resolves to `undefined`
4. (Optional) `hasOwnProperty` (bool - `default : false`) Checks for the property only on the current object but NOT on Prototype/Parent.

### Example

```js
var getValue = require('object-getvalue');
OR
import getValue from 'object-getvalue';

var Person = function() {
	this.name = 'No name defined yet';
	this.age = 25;
	this.address = {
		city: 'Default - New Delhi',
		country: 'Default - India'
	};
};

var Employee = function() {
	this.name = 'Ravi Roshan';
	this.company = 'XYZ Consulting';
	this.empId = 12345;
	this.address = {
		city: 'Bangalore'
	};
	this.details = {
		role: 'Developer',
		designation: 'Consultant',
		domain: 'e-commerce'
	};
	this.friends = [{
		name: 'Siddhant',
		age: 27
	}, {
		name: 'Harsh',
		age: 26
	}, {
		name: 'Argha',
		age: 28
	}];
};

// Inherit the Person Object
Employee.prototype = new Person();

// Create an instance of Employee
var emp1 = new Employee();

// Check for property on Current Object
getValue(emp1, 'name') //=> 'Ravi Roshan'
getValue(emp1, 'details.domain') //=> 'e-commerce'
getValue(emp1, 'details.language.primary') //=> undefined

// Check for property on Prototype Object'
getValue(emp1, 'age') //=> 25 [Getting from prototype Person Object]
getValue(emp1, 'address.area.pincode') //=> undefined

// Check for property on Current Object - with Default Return
getValue(emp1, 'salary', 9999) //=> 9999
getValue(emp1, 'salary', 'Salary not found') //=> 'Salary not found'
getValue(emp1, 'name', 'John') //=> 'Ravi Roshan' [name doesn't resolve to undefined so defaultReturn is not considered]

// Check for property ONLY on Current Object
getValue(emp1, 'age', 'Age not found', true) //=> 'Age not found'

// Check for property on Current OR Prototype Object
getValue(emp1, 'age', 'Age not found', false) //=> 25

// Check for the name property on Friends [array] on Emp [object]
getValue(emp1, 'friends[1].name') //=> 'Harsh'

```

## License

MIT

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