0.2.2 • Published 5 months ago

@stdlib/utils-pick v0.2.2

Weekly downloads
-
License
Apache-2.0
Repository
github
Last release
5 months ago

pick

NPM version Build Status Coverage Status

Return a partial object copy containing only specified keys.

Installation

npm install @stdlib/utils-pick

Usage

var pick = require( '@stdlib/utils-pick' );

pick( obj, keys )

Returns a partial copy of an object. The returned object contains only specified keys.

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

var obj2 = pick( obj1, 'b' );
// returns { 'b': 2 }

var obj3 = pick( obj1, [ 'b', 'c' ] );
// returns { 'b': 2, 'c': 3 }

If a key does not exist as an own property in a source object, the key is ignored.

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

var obj2 = pick( obj1, 'd' );
// returns {}

Notes

  • The function returns a shallow copy.
  • The function only copies own properties. Hence, the function never copies inherited properties.

Examples

var pick = require( '@stdlib/utils-pick' );

var obj1 = {
    'a': 1,
    'b': 2,
    'c': 3,
    'd': 4,
    'e': 5
};

var obj2 = pick( obj1, [ 'b', 'c', 'e' ] );
// returns { 'b': 2, 'c': 3, 'e': 5 }

See Also

  • @stdlib/utils-pick-by: return a partial object copy containing properties for which a predicate (function) returns a truthy value.

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

Chat


License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.