@stdlib/utils-omit-by
    TypeScript icon, indicating that this package has built-in type declarations

    0.0.7 • Public • Published

    omitBy

    NPM version Build Status Coverage Status dependencies

    Return a partial object copy excluding properties for which a predicate (function) returns a truthy value.

    Installation

    npm install @stdlib/utils-omit-by

    Usage

    var omitBy = require( '@stdlib/utils-omit-by' );

    omitBy( obj, predicate )

    Returns a partial object copy excluding properties for which a predicate returns a truthy value.

    function predicate( key, value ) {
        return ( value > 1 );
    }
    
    var obj1 = {
        'a': 1,
        'b': 2,
        'c': 3
    };
    
    var obj2 = omitBy( obj1, predicate );
    // returns { 'a': 1 }

    Notes

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

    Examples

    var omitBy = require( '@stdlib/utils-omit-by' );
    
    function predicate( key, value ) {
        return ( typeof value === 'number' );
    }
    
    var obj1 = {
        'a': '1',
        'b': 2,
        'c': NaN,
        'd': null
    };
    
    var obj2 = omitBy( obj1, predicate );
    // returns { 'a': '1', 'd': null }

    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-2021. The Stdlib Authors.

    Install

    npm i @stdlib/utils-omit-by

    Homepage

    stdlib.io

    DownloadsWeekly Downloads

    1

    Version

    0.0.7

    License

    Apache-2.0

    Unpacked Size

    38 kB

    Total Files

    9

    Last publish

    Collaborators

    • stdlib-bot
    • kgryte
    • planeshifter
    • rreusser