@stdlib/utils-pick

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!

pick

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

---

License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.

Changelog

0.2.0 (2024-02-14)

No changes reported for this release.

</section> <!-- /.release --> <section class="release" id="v0.1.1">