https://github.com/stdlib-js/utils-deep-get
Get a nested property value.
https://github.com/stdlib-js/utils-deep-get
array deep get javascript nested node node-js nodejs obj object prop property stdlib util utilities utility utils
Last synced: 10 months ago
JSON representation
Get a nested property value.
- Host: GitHub
- URL: https://github.com/stdlib-js/utils-deep-get
- Owner: stdlib-js
- License: apache-2.0
- Created: 2021-06-15T17:46:08.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-03-17T01:08:00.000Z (11 months ago)
- Last Synced: 2025-03-25T15:01:44.114Z (11 months ago)
- Topics: array, deep, get, javascript, nested, node, node-js, nodejs, obj, object, prop, property, stdlib, util, utilities, utility, utils
- Language: JavaScript
- Homepage: https://github.com/stdlib-js/stdlib
- Size: 1.26 MB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff
- Security: SECURITY.md
Awesome Lists containing this project
README
About stdlib...
We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.
The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.
When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.
To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!
# Deep Get
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Get a nested property value.
## Installation
```bash
npm install @stdlib/utils-deep-get
```
Alternatively,
- To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]).
- If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).
- For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]).
The [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships.
To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.
## Usage
```javascript
var deepGet = require( '@stdlib/utils-deep-get' );
```
#### deepGet( obj, path\[, options] )
Returns a nested property value.
```javascript
var obj = { 'a': { 'b': { 'c': 'd' } } };
var val = deepGet( obj, 'a.b.c' );
// returns 'd'
```
For `paths` including `arrays`, specify the numeric index.
```javascript
var arr = [
{ 'a': [ {'x': 5} ] },
{ 'a': [ {'x': 10} ] }
];
var val = deepGet( arr, '1.a.0.x' );
// returns 10
```
The key `path` may be specified as either a delimited `string` or a key `array`.
```javascript
var obj = { 'a': { 'b': { 'c': 'd' } } };
var val = deepGet( obj, [ 'a', 'b', 'c' ] );
// returns 'd'
```
The function accepts the following `options`:
- **sep**: key path separator. Default: `'.'`.
By default, the function assumes `dot` separated key values. To specify an alternative separator, set the `sep` option.
```javascript
var obj = { 'a': { 'b': { 'c': 'd' } } };
var val = deepGet( obj, 'a/b/c', {
'sep': '/'
});
// returns 'd'
```
#### deepGet.factory( path\[, options] )
Creates a reusable deep get function. The factory method ensures a `deepGet` function is configured identically by using the same set of provided `options`.
```javascript
var dget = deepGet.factory( 'a/b/c', {
'sep': '/'
});
```
#### dget( obj )
Returns a nested property value.
```javascript
var dget = deepGet.factory( 'a.b.c' );
var obj = { 'a': { 'b': { 'c': 'd' } } };
var val = dget( obj );
// returns 'd'
```
## Examples
```javascript
var randu = require( '@stdlib/random-base-randu' );
var deepGet = require( '@stdlib/utils-deep-get' );
var data;
var keys;
var val;
var i;
data = new Array( 100 );
for ( i = 0; i < data.length; i++ ) {
data[ i ] = {
'x': Date.now(),
'y': [ randu(), randu(), i ]
};
}
keys = [ 0, 'y', 2 ];
for ( i = 0; i < data.length; i++ ) {
keys[ 0 ] = i;
val = deepGet( data, keys );
console.log( val );
}
```
* * *
## See Also
- [`@stdlib/utils-deep-pluck`][@stdlib/utils/deep-pluck]: extract a nested property value from each element of an object array.
- [`@stdlib/utils-deep-set`][@stdlib/utils/deep-set]: set a nested property value.
* * *
## Notice
This package is part of [stdlib][stdlib], a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.
For more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib].
#### Community
[![Chat][chat-image]][chat-url]
---
## License
See [LICENSE][stdlib-license].
## Copyright
Copyright © 2016-2025. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/utils-deep-get.svg
[npm-url]: https://npmjs.org/package/@stdlib/utils-deep-get
[test-image]: https://github.com/stdlib-js/utils-deep-get/actions/workflows/test.yml/badge.svg?branch=main
[test-url]: https://github.com/stdlib-js/utils-deep-get/actions/workflows/test.yml?query=branch:main
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/utils-deep-get/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/utils-deep-get?branch=main
[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
[stdlib]: https://github.com/stdlib-js/stdlib
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
[umd]: https://github.com/umdjs/umd
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
[deno-url]: https://github.com/stdlib-js/utils-deep-get/tree/deno
[deno-readme]: https://github.com/stdlib-js/utils-deep-get/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/utils-deep-get/tree/umd
[umd-readme]: https://github.com/stdlib-js/utils-deep-get/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/utils-deep-get/tree/esm
[esm-readme]: https://github.com/stdlib-js/utils-deep-get/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/utils-deep-get/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/utils-deep-get/main/LICENSE
[@stdlib/utils/deep-pluck]: https://github.com/stdlib-js/utils-deep-pluck
[@stdlib/utils/deep-set]: https://github.com/stdlib-js/utils-deep-set