@stdlib/utils
Version:
Standard utilities.
126 lines (78 loc) • 2.5 kB
Markdown
<!--
@license Apache-2.0
Copyright (c) 2021 The Stdlib Authors.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
# commonKeys
> Return the common own property names of two or more objects.
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
<section class="intro">
</section>
<!-- /.intro -->
<!-- Package usage documentation. -->
<section class="usage">
## Usage
```javascript
var commonKeys = require( '@stdlib/utils/common-keys' );
```
#### commonKeys( obj1, obj2\[, obj3\[,...,objN]] )
Returns the common own property names of two or more objects.
```javascript
var obj = {
'a': 1,
'b': 2,
'c': 3
};
var obj2 = {
'a': 1,
'b': 2
};
var keys = commonKeys( obj, obj2 );
// returns [ 'a', 'b' ]
```
</section>
<!-- /.usage -->
<!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
<section class="notes">
</section>
<!-- /.notes -->
<!-- Package usage examples. -->
<section class="examples">
## Examples
<!-- eslint no-undef: "error" -->
```javascript
var commonKeys = require( '@stdlib/utils/common-keys' );
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 = commonKeys( obj1, obj2 );
// returns [ 'beep' ]
```
</section>
<!-- /.examples -->
<!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
<section class="references">
</section>
<!-- /.references -->
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
<section class="links">
</section>
<!-- /.links -->