Nihilist Pocket Monsters
Introducing npm Teams! Private packages + team management tools.Learn more »

is-subset

0.1.1 • Public • Published

Coveralls – test coverage Travis – build status David – status of dependencies Code style: airbnb

is-subset

Check if an object is contained within another one.

Installation

$ npm install is-subset

Usage

  1. Import the module:
import isSubset from 'is-subset/module';
 
// …or:
var isSubset = require('is-subset');
  1. These are true:
isSubset(
  {a: 1, b: 2},
  {a: 1}
);
 
isSubset(
  {a: 1, b: {c: 3, d: 4}, e: 5},
  {a: 1, b: {c: 3}}
);
 
isSubset(
  {a: 1, bcd: [1, 2, 3]},
  {a: 1, bcd: [1, 2]}
);

…and these are false:

isSubset(
  {a: 1},
  {a: 2}
);
 
isSubset(
  {a: 1},
  {a: 1, b: 2}
);
 
isSubset(
  {a: 1, bcd: [1, 2, 3]},
  {a: 1, bcd: [1, 3]}
);

See the specs for more info.

API

isSubset(superset, subset)

Check if an object is contained within another object.

Returns true if:

  • all enumerable keys of subset are also enumerable in superset, and
  • every value assigned to an enumerable key of subset strictly equals the value assigned to the same key of superset – or is a subset of it.

Parameters:

  • Object superset
  • Object subset

Return value:

  • Boolean

License

MIT © Studio B12 GmbH

Install

npm i is-subset

DownloadsWeekly Downloads

1,953,323

Version

0.1.1

License

MIT

Last publish

Collaborators

  • avatar