Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/stdlib-js/assert-deep-has-property

Test whether an object contains a nested key path, either own or inherited.
https://github.com/stdlib-js/assert-deep-has-property

assert assertion deephas deephasown deephasownproperty deephasproperty javascript node node-js nodejs obj object prop property stdlib test util utilities utility utils

Last synced: about 1 month ago
JSON representation

Test whether an object contains a nested key path, either own or inherited.

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!



# deepHasProp



[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] 



> Test whether an object contains a nested key path, either own or inherited.



## Installation



```bash

npm install @stdlib/assert-deep-has-property

```



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 deepHasProp = require( '@stdlib/assert-deep-has-property' );

```



#### deepHasProp( value, path\[, options] )



Returns a `boolean` indicating if a `value` has a specified `path`, either own or inherited.



```javascript

function Foo() {

    return this;

}

Foo.prototype.b = {

    'c': 'd'

};



var obj = { 'a': new Foo() };



var bool = deepHasProp( obj, 'a.b.c' );

// returns true



bool = deepHasProp( obj, 'a.b.c.d.e' );

// returns false

```



If a key path includes an `array`, specify the numeric index.



```javascript

var arr = [

    {

        'a': [

            {

                'b': [

                    { 'c': 'd' },

                    { 'e': 'f' }

                ]

            }

        ]

    }

];



var bool = deepHasProp( arr, '0.a.0.b.0.c' );

// returns true



bool = deepHasProp( arr, '0.a.1.b.0.c' );

// returns false



bool = deepHasProp( arr, '0.a.0.b.1.c' );

// returns false

```



The key path may be specified as either a delimited `string` or a key `array`.



```javascript

var obj = { 'a': { 'b': { 'c': 'd' } } };



var bool = deepHasProp( obj, [ 'a', 'b', 'c' ] );

// returns true

```



The function accepts the following `options`:



-   **sep**: key path separator. Default: `'.'`.



By default, the function assumes `.` separated key values. To specify an alternative separator, set the `sep` option.



```javascript

var obj = { 'a': { 'b': { 'c': 'd' } } };



var bool = deepHasProp( obj, 'a/b/c', {

    'sep': '/'

});

// returns true

```



#### deepHasProp.factory( path\[, options] )



Returns a `function` which tests whether a `value` contains a nested key `path`, either own or inherited.



```javascript

var has = deepHasProp.factory( 'a/b/c', {

    'sep': '/'

});

```



#### has( value )



Returns a `boolean` indicating whether a `value` contains a nested key `path`, either own or inherited.



```javascript

var has = deepHasProp.factory( 'a.b.c' );



function Foo() {

    return this;

}

Foo.prototype.b = {

    'c': 'd'

};



var obj = { 'a': new Foo() };



var bool = has( obj );

// returns true

```



## Notes



-   When provided `null` or `undefined`, the function result is always `false`.



    ```javascript

    var bool = deepHasProp( null, 'a.b.c' );

    // returns false



    bool = deepHasProp( void 0, 'a.b.c' );

    // returns false

    ```



-   Property values other than `null` or `undefined` are coerced to `objects`.



    ```javascript

    var obj = {

        'a': 'b'

    };



    var bool = deepHasProp( obj, 'a.length' );

    // returns true

    ```



-   Key path `array` elements are coerced to `strings`.



    ```javascript

    var obj = {

        'null': false

    };

    var bool = deepHasProp( obj, [ null ] );

    // returns true



    obj = {

        '[object Object]': false

    };

    bool = deepHasProp( obj, [ {} ] );

    // returns true

    ```



## Examples



```javascript

var deepHasProp = require( '@stdlib/assert-deep-has-property' );



var bool = deepHasProp( { 'a': { 'b': { 'c': 'd' } } }, 'a.b.c' );

// returns true



bool = deepHasProp( { 'a': { 'b': { 'c': 'd' } } }, [ 'a', 'b', 'hasOwnProperty' ] );

// returns true



bool = deepHasProp( { 'a': { 'b': { 'c': 'd' } } }, 'a/b/c', {

    'sep': '/'

});

// returns true



bool = deepHasProp( { 'a': { 'b': { 'c': 'd' } } }, 'a.b.c.d' );

// returns false



bool = deepHasProp( { 'a': [ { 'b': { 'c': 'd' } } ] }, [ 'a', '0', 'b', 'c', 'd' ] );

// returns false



bool = deepHasProp( { 'a': { 'b': { 'c': 'd' } } }, 'a/b/c/d/e', {

    'sep': '/'

});

// returns false



// Create a customized function:

var has = deepHasProp.factory( 'a_b_c', {

    'sep': '_'

});



bool = has( { 'a': { 'b': { 'c': 'd' } } } );

// returns true



bool = has( { 'a': [ { 'b': { 'c': 'd' } } ] } );

// returns false

```



* * *



## See Also



-   [`@stdlib/assert-deep-has-own-property`][@stdlib/assert/deep-has-own-property]: test whether an object contains a nested key path.

-   [`@stdlib/assert-has-own-property`][@stdlib/assert/has-own-property]: test if an object has a specified property.

-   [`@stdlib/utils-deep-get`][@stdlib/utils/deep-get]: get a nested property value.

-   [`@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-2024. The Stdlib [Authors][stdlib-authors].



[npm-image]: http://img.shields.io/npm/v/@stdlib/assert-deep-has-property.svg

[npm-url]: https://npmjs.org/package/@stdlib/assert-deep-has-property



[test-image]: https://github.com/stdlib-js/assert-deep-has-property/actions/workflows/test.yml/badge.svg?branch=main

[test-url]: https://github.com/stdlib-js/assert-deep-has-property/actions/workflows/test.yml?query=branch:main



[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/assert-deep-has-property/main.svg

[coverage-url]: https://codecov.io/github/stdlib-js/assert-deep-has-property?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/assert-deep-has-property/tree/deno

[deno-readme]: https://github.com/stdlib-js/assert-deep-has-property/blob/deno/README.md

[umd-url]: https://github.com/stdlib-js/assert-deep-has-property/tree/umd

[umd-readme]: https://github.com/stdlib-js/assert-deep-has-property/blob/umd/README.md

[esm-url]: https://github.com/stdlib-js/assert-deep-has-property/tree/esm

[esm-readme]: https://github.com/stdlib-js/assert-deep-has-property/blob/esm/README.md

[branches-url]: https://github.com/stdlib-js/assert-deep-has-property/blob/main/branches.md



[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/assert-deep-has-property/main/LICENSE



[@stdlib/assert/deep-has-own-property]: https://github.com/stdlib-js/assert-deep-has-own-property



[@stdlib/assert/has-own-property]: https://github.com/stdlib-js/assert-has-own-property



[@stdlib/utils/deep-get]: https://github.com/stdlib-js/utils-deep-get



[@stdlib/utils/deep-pluck]: https://github.com/stdlib-js/utils-deep-pluck



[@stdlib/utils/deep-set]: https://github.com/stdlib-js/utils-deep-set