utils-common-keys-in

Return the common own and inherited property names of two or more objects.

APACHE-2.0 License

Downloads
11
Stars
2
Committers
1

commonKeysIn

Return the common own and inherited property names of two or more objects.

Installation

npm install @stdlib/utils-common-keys-in

Alternatively,

  • To load the package in a website via a script tag without installation and bundlers, use the ES Module available on the esm branch (see README).
  • If you are using Deno, visit the deno branch (see README for usage intructions).
  • For use in Observable, or in browser/node environments, use the Universal Module Definition (UMD) build available on the umd branch (see README).

The branches.md 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

var commonKeysIn = require( '@stdlib/utils-common-keys-in' );

commonKeysIn( obj1, obj2[, obj3[,...,objN]] )

Returns the common own and inherited property names of two or more objects.

var obj = {
    'a': 1,
    'b': 2,
    'c': 3
};

var obj2 = {
    'a': 1,
    'b': 2
};

var keys = commonKeysIn( obj, obj2 );
// returns [ 'a', 'b' ]

Examples

var commonKeysIn = require( '@stdlib/utils-common-keys-in' );

function Foo() {
    this.beep = 'boop';
    this.a = {
        'b': 'c'
    };
    return this;
}

Foo.prototype.foo = [ 'bar' ];

var obj1 = new Foo();

var obj2 = {
    'beep': 'boop',
    'foo': 'bar'
};

var keys = commonKeysIn( obj1, obj2 );
// returns [ 'beep', 'foo' ]

Notice

This package is part of 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, see the main project repository.

Community


License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.