Noteworthy Programming Masterpiece

    obj-subset

    1.2.0 • Public • Published

    obj-subset travis-ci

    Determine if one object is a subset of another object in node and the browser. Also works on arrays.

    A large portion of this code was lifted from chai-subset.

    Installation

    npm:

    $ npm install obj-subset
    

    API

    isSubset(original, subset, [strict])

    Returns true if original contains all of the properties and values of subset, otherwise returns false. strict is set to true by default. Setting to false will allow lenient equality comparisons (== vs ===);

    Usage

    var isSubset = require('obj-subset');
    
    var users = [{
        id: '1234',
        name: 'Foo',
        email: 'bar@baz.com'
    },
    {
        id: '5678',
        name: 'Foo',
        email: 'bar@qux.com'
    }];
    
    var lookUp = {
        name: 'Foo',
        email: 'bar@qux.com'
    };
    
    isSubset(users[0], lookUp); // returns `false`
    isSubset(users[1], lookUp); // returns `true`
    

    License

    The MIT License (MIT)

    Copyright (c) 2017 Kevin Neff kvnneff@gmail.com

    Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

    The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

    Install

    npm i obj-subset

    DownloadsWeekly Downloads

    10

    Version

    1.2.0

    License

    MIT

    Last publish

    Collaborators

    • kvnneff
    • staygrimm