Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -253,7 +253,7 @@ bool = has( { 'a': [ { 'b': { 'c': 'd' } } ] } );

- <span class="package-name">[`@stdlib/assert/deep-has-property`][@stdlib/assert/deep-has-property]</span><span class="delimiter">: </span><span class="description">test whether an object contains a nested key path, either own or inherited.</span>
- <span class="package-name">[`@stdlib/assert/has-own-property`][@stdlib/assert/has-own-property]</span><span class="delimiter">: </span><span class="description">test if an object has a specified property.</span>
- <span class="package-name">[`@stdlib/utils/deep-get`][@stdlib/utils/deep-get]</span><span class="delimiter">: </span><span class="description">get a nested property value.</span>
- <span class="package-name">[`@stdlib/object/deep-get`][@stdlib/object/deep-get]</span><span class="delimiter">: </span><span class="description">get a nested property value.</span>
- <span class="package-name">[`@stdlib/utils/deep-pluck`][@stdlib/utils/deep-pluck]</span><span class="delimiter">: </span><span class="description">extract a nested property value from each element of an object array.</span>
- <span class="package-name">[`@stdlib/utils/deep-set`][@stdlib/utils/deep-set]</span><span class="delimiter">: </span><span class="description">set a nested property value.</span>

Expand All @@ -271,7 +271,7 @@ bool = has( { 'a': [ { 'b': { 'c': 'd' } } ] } );

[@stdlib/assert/has-own-property]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/has-own-property

[@stdlib/utils/deep-get]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/deep-get
[@stdlib/object/deep-get]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/object/deep-get

[@stdlib/utils/deep-pluck]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/deep-pluck

Expand Down
4 changes: 2 additions & 2 deletions lib/node_modules/@stdlib/assert/deep-has-property/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -249,7 +249,7 @@ bool = has( { 'a': [ { 'b': { 'c': 'd' } } ] } );

- <span class="package-name">[`@stdlib/assert/deep-has-own-property`][@stdlib/assert/deep-has-own-property]</span><span class="delimiter">: </span><span class="description">test whether an object contains a nested key path.</span>
- <span class="package-name">[`@stdlib/assert/has-own-property`][@stdlib/assert/has-own-property]</span><span class="delimiter">: </span><span class="description">test if an object has a specified property.</span>
- <span class="package-name">[`@stdlib/utils/deep-get`][@stdlib/utils/deep-get]</span><span class="delimiter">: </span><span class="description">get a nested property value.</span>
- <span class="package-name">[`@stdlib/object/deep-get`][@stdlib/object/deep-get]</span><span class="delimiter">: </span><span class="description">get a nested property value.</span>
- <span class="package-name">[`@stdlib/utils/deep-pluck`][@stdlib/utils/deep-pluck]</span><span class="delimiter">: </span><span class="description">extract a nested property value from each element of an object array.</span>
- <span class="package-name">[`@stdlib/utils/deep-set`][@stdlib/utils/deep-set]</span><span class="delimiter">: </span><span class="description">set a nested property value.</span>

Expand All @@ -267,7 +267,7 @@ bool = has( { 'a': [ { 'b': { 'c': 'd' } } ] } );

[@stdlib/assert/has-own-property]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/has-own-property

[@stdlib/utils/deep-get]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/deep-get
[@stdlib/object/deep-get]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/object/deep-get

[@stdlib/utils/deep-pluck]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/deep-pluck

Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/namespace/alias2pkg/data/data.csv
Original file line number Diff line number Diff line change
Expand Up @@ -1581,7 +1581,7 @@ debugSinkStream,"@stdlib/streams/node/debug-sink"
debugStream,"@stdlib/streams/node/debug"
decorateAfter,"@stdlib/utils/decorate-after"
deepEqual,"@stdlib/assert/deep-equal"
deepGet,"@stdlib/utils/deep-get"
deepGet,"@stdlib/object/deep-get"
deepHasOwnProp,"@stdlib/assert/deep-has-own-property"
deepHasProp,"@stdlib/assert/deep-has-property"
deepPluck,"@stdlib/utils/deep-pluck"
Expand Down
12 changes: 6 additions & 6 deletions lib/node_modules/@stdlib/namespace/lib/namespace/d.js
Original file line number Diff line number Diff line change
Expand Up @@ -176,8 +176,8 @@ ns.push({

ns.push({
'alias': 'deepGet',
'path': '@stdlib/utils/deep-get',
'value': require( '@stdlib/utils/deep-get' ),
'path': '@stdlib/object/deep-get',
'value': require( '@stdlib/object/deep-get' ),
'type': 'Function',
'related': [
'@stdlib/utils/deep-pluck',
Expand All @@ -193,7 +193,7 @@ ns.push({
'related': [
'@stdlib/assert/deep-has-property',
'@stdlib/assert/has-own-property',
'@stdlib/utils/deep-get',
'@stdlib/object/deep-get',
'@stdlib/utils/deep-pluck',
'@stdlib/utils/deep-set'
]
Expand All @@ -207,7 +207,7 @@ ns.push({
'related': [
'@stdlib/assert/deep-has-own-property',
'@stdlib/assert/has-own-property',
'@stdlib/utils/deep-get',
'@stdlib/object/deep-get',
'@stdlib/utils/deep-pluck',
'@stdlib/utils/deep-set'
]
Expand All @@ -219,7 +219,7 @@ ns.push({
'value': require( '@stdlib/utils/deep-pluck' ),
'type': 'Function',
'related': [
'@stdlib/utils/deep-get',
'@stdlib/object/deep-get',
'@stdlib/utils/deep-set'
]
});
Expand All @@ -230,7 +230,7 @@ ns.push({
'value': require( '@stdlib/utils/deep-set' ),
'type': 'Function',
'related': [
'@stdlib/utils/deep-get',
'@stdlib/object/deep-get',
'@stdlib/utils/deep-pluck'
]
});
Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/namespace/pkg2alias/data/data.csv
Original file line number Diff line number Diff line change
Expand Up @@ -1581,7 +1581,7 @@
"@stdlib/streams/node/debug",debugStream
"@stdlib/utils/decorate-after",decorateAfter
"@stdlib/assert/deep-equal",deepEqual
"@stdlib/utils/deep-get",deepGet
"@stdlib/object/deep-get",deepGet
"@stdlib/assert/deep-has-own-property",deepHasOwnProp
"@stdlib/assert/deep-has-property",deepHasProp
"@stdlib/utils/deep-pluck",deepPluck
Expand Down
10 changes: 5 additions & 5 deletions lib/node_modules/@stdlib/namespace/pkg2related/data/data.csv
Original file line number Diff line number Diff line change
Expand Up @@ -1581,11 +1581,11 @@
"@stdlib/streams/node/debug","@stdlib/streams/node/debug-sink,@stdlib/streams/node/inspect"
"@stdlib/utils/decorate-after",""
"@stdlib/assert/deep-equal","@stdlib/assert/is-strict-equal,@stdlib/assert/is-same-value"
"@stdlib/utils/deep-get","@stdlib/utils/deep-pluck,@stdlib/utils/deep-set"
"@stdlib/assert/deep-has-own-property","@stdlib/assert/deep-has-property,@stdlib/assert/has-own-property,@stdlib/utils/deep-get,@stdlib/utils/deep-pluck,@stdlib/utils/deep-set"
"@stdlib/assert/deep-has-property","@stdlib/assert/deep-has-own-property,@stdlib/assert/has-own-property,@stdlib/utils/deep-get,@stdlib/utils/deep-pluck,@stdlib/utils/deep-set"
"@stdlib/utils/deep-pluck","@stdlib/utils/deep-get,@stdlib/utils/deep-set"
"@stdlib/utils/deep-set","@stdlib/utils/deep-get,@stdlib/utils/deep-pluck"
"@stdlib/object/deep-get","@stdlib/utils/deep-pluck,@stdlib/utils/deep-set"
"@stdlib/assert/deep-has-own-property","@stdlib/assert/deep-has-property,@stdlib/assert/has-own-property,@stdlib/object/deep-get,@stdlib/utils/deep-pluck,@stdlib/utils/deep-set"
"@stdlib/assert/deep-has-property","@stdlib/assert/deep-has-own-property,@stdlib/assert/has-own-property,@stdlib/object/deep-get,@stdlib/utils/deep-pluck,@stdlib/utils/deep-set"
"@stdlib/utils/deep-pluck","@stdlib/object/deep-get,@stdlib/utils/deep-set"
"@stdlib/utils/deep-set","@stdlib/object/deep-get,@stdlib/utils/deep-pluck"
"@stdlib/utils/define-memoized-property","@stdlib/utils/define-memoized-read-only-property,@stdlib/utils/define-property"
"@stdlib/utils/define-properties","@stdlib/utils/define-property,@stdlib/utils/define-read-only-property"
"@stdlib/utils/define-property","@stdlib/utils/define-properties,@stdlib/utils/define-read-only-property"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1581,7 +1581,7 @@
"@stdlib/streams/node/debug","@stdlib/streams-node-debug"
"@stdlib/utils/decorate-after","@stdlib/utils-decorate-after"
"@stdlib/assert/deep-equal","@stdlib/assert-deep-equal"
"@stdlib/utils/deep-get","@stdlib/utils-deep-get"
"@stdlib/object/deep-get","@stdlib/object-deep-get"
"@stdlib/assert/deep-has-own-property","@stdlib/assert-deep-has-own-property"
"@stdlib/assert/deep-has-property","@stdlib/assert-deep-has-property"
"@stdlib/utils/deep-pluck","@stdlib/utils-deep-pluck"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1581,7 +1581,7 @@
"@stdlib/streams-node-debug","@stdlib/streams/node/debug"
"@stdlib/utils-decorate-after","@stdlib/utils/decorate-after"
"@stdlib/assert-deep-equal","@stdlib/assert/deep-equal"
"@stdlib/utils-deep-get","@stdlib/utils/deep-get"
"@stdlib/object-deep-get","@stdlib/object/deep-get"
"@stdlib/assert-deep-has-own-property","@stdlib/assert/deep-has-own-property"
"@stdlib/assert-deep-has-property","@stdlib/assert/deep-has-property"
"@stdlib/utils-deep-pluck","@stdlib/utils/deep-pluck"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ limitations under the License.
## Usage

```javascript
var deepGet = require( '@stdlib/utils/deep-get' );
var deepGet = require( '@stdlib/object/deep-get' );
```

#### deepGet( obj, path\[, options] )
Expand Down Expand Up @@ -122,7 +122,7 @@ var val = dget( obj );

```javascript
var randu = require( '@stdlib/random/base/randu' );
var deepGet = require( '@stdlib/utils/deep-get' );
var deepGet = require( '@stdlib/object/deep-get' );

var data;
var keys;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,10 @@
/**
* Get a nested property value.
*
* @module @stdlib/utils/deep-get
* @module @stdlib/object/deep-get
*
* @example
* var deepGet = require( '@stdlib/utils/deep-get' );
* var deepGet = require( '@stdlib/object/deep-get' );
*
* var obj = { 'a': { 'b': { 'c': 'd' } } };
*
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "@stdlib/utils/deep-get",
"name": "@stdlib/object/deep-get",
"version": "0.0.0",
"description": "Get a nested property value.",
"license": "Apache-2.0",
Expand Down
6 changes: 3 additions & 3 deletions lib/node_modules/@stdlib/utils/deep-pluck/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ var out = deepPluck( arr, [ 'a', 1 ] );
The function accepts the following `options`:

- **copy**: `boolean` indicating whether to return a new data structure. Default: `true`.
- **sep**: key path [separator][@stdlib/utils/deep-get]. Default: `'.'`.
- **sep**: key path [separator][@stdlib/object/deep-get]. Default: `'.'`.

By default, the function returns a new data structure. To mutate the input data structure (e.g., when input values can be discarded or when optimizing memory usage), set the `copy` option to `false`.

Expand Down Expand Up @@ -215,7 +215,7 @@ console.log( out );

## See Also

- <span class="package-name">[`@stdlib/utils/deep-get`][@stdlib/utils/deep-get]</span><span class="delimiter">: </span><span class="description">get a nested property value.</span>
- <span class="package-name">[`@stdlib/object/deep-get`][@stdlib/object/deep-get]</span><span class="delimiter">: </span><span class="description">get a nested property value.</span>
- <span class="package-name">[`@stdlib/utils/deep-set`][@stdlib/utils/deep-set]</span><span class="delimiter">: </span><span class="description">set a nested property value.</span>

</section>
Expand All @@ -230,7 +230,7 @@ console.log( out );

<!-- <related-links> -->

[@stdlib/utils/deep-get]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/deep-get
[@stdlib/object/deep-get]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/object/deep-get

[@stdlib/utils/deep-set]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/deep-set

Expand Down
2 changes: 1 addition & 1 deletion lib/node_modules/@stdlib/utils/deep-pluck/lib/main.js
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@

// MODULES //

var deepGet = require( '@stdlib/utils/deep-get' ).factory;
var deepGet = require( '@stdlib/object/deep-get' ).factory;
var isArray = require( '@stdlib/assert/is-array' );
var format = require( '@stdlib/string/format' );
var defaults = require( './defaults.js' );
Expand Down Expand Up @@ -99,7 +99,7 @@
}
}
if ( opts.copy ) {
out = new Array( arr.length );

Check failure on line 102 in lib/node_modules/@stdlib/utils/deep-pluck/lib/main.js

View workflow job for this annotation

GitHub Actions / Lint Changed Files

Using the `new Array()` constructor is not allowed; use an array literal with push instead
} else {
out = arr;
}
Expand Down
4 changes: 2 additions & 2 deletions lib/node_modules/@stdlib/utils/deep-set/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -249,7 +249,7 @@ console.log( data );

## See Also

- <span class="package-name">[`@stdlib/utils/deep-get`][@stdlib/utils/deep-get]</span><span class="delimiter">: </span><span class="description">get a nested property value.</span>
- <span class="package-name">[`@stdlib/object/deep-get`][@stdlib/object/deep-get]</span><span class="delimiter">: </span><span class="description">get a nested property value.</span>
- <span class="package-name">[`@stdlib/utils/deep-pluck`][@stdlib/utils/deep-pluck]</span><span class="delimiter">: </span><span class="description">extract a nested property value from each element of an object array.</span>

</section>
Expand All @@ -262,7 +262,7 @@ console.log( data );

<!-- <related-links> -->

[@stdlib/utils/deep-get]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/deep-get
[@stdlib/object/deep-get]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/object/deep-get

[@stdlib/utils/deep-pluck]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/utils/deep-pluck

Expand Down
28 changes: 0 additions & 28 deletions lib/node_modules/@stdlib/utils/docs/types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,6 @@ import countBy = require( '@stdlib/utils/count-by' );
import curry = require( '@stdlib/utils/curry' );
import curryRight = require( '@stdlib/utils/curry-right' );
import decorateAfter = require( '@stdlib/utils/decorate-after' );
import deepGet = require( '@stdlib/utils/deep-get' );
import deepPluck = require( '@stdlib/utils/deep-pluck' );
import deepSet = require( '@stdlib/utils/deep-set' );
import setConfigurableReadOnlyAccessor = require( '@stdlib/utils/define-configurable-read-only-accessor' );
Expand Down Expand Up @@ -707,33 +706,6 @@ interface Namespace {
*/
decorateAfter: typeof decorateAfter;

/**
* Returns a nested property value.
*
* @param obj - input object
* @param path - key path
* @param options - function options
* @param options.sep - key path separator (default: '.')
* @returns nested property value
*
* @example
* var obj = { 'a': { 'b': { 'c': 'd' } } };
*
* var val = ns.deepGet( obj, 'a.b.c' );
* // returns 'd'
*
* @example
* var dget = ns.deepGet.factory( 'a/b/c', {
* 'sep': '/'
* });
*
* var obj = { 'a': { 'b': { 'c': 'd' } } };
*
* var val = dget( obj );
* // returns 'd'
*/
deepGet: typeof deepGet;

/**
* Extracts a nested property value from each element of an object array.
*
Expand Down
9 changes: 0 additions & 9 deletions lib/node_modules/@stdlib/utils/lib/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -193,15 +193,6 @@ setReadOnly( utils, 'curryRight', require( '@stdlib/utils/curry-right' ) );
*/
setReadOnly( utils, 'decorateAfter', require( '@stdlib/utils/decorate-after' ) );

/**
* @name deepGet
* @memberof utils
* @readonly
* @type {Function}
* @see {@link module:@stdlib/utils/deep-get}
*/
setReadOnly( utils, 'deepGet', require( '@stdlib/utils/deep-get' ) );

/**
* @name deepPluck
* @memberof utils
Expand Down
Loading