filter-object - npm Package Compare versions

Comparing version 2.1.0 to 3.0.0

index.js

 'use strict';
 
-var typeOf = require('kind-of');
-var filterKeys = require('filter-keys');
 var filterValues = require('filter-values');
-var pick = require('object.pick');
-var extend = require('extend-shallow');
+var isObject = require('isobject');
+var glob = require('glob-object');
 
-module.exports = function filterObject(val, patterns, options) {
-  if (!val || typeof val !== 'object') {
-    throw new Error('filter-object expects an object');
+module.exports = function(obj, patterns, options) {
+  if (!isObject(obj)) {
+    throw new TypeError('expected an object');
   }
 
-  if (patterns == null) return val;
+  if (!patterns) {
+    return obj;
+  }
 
-  if (typeOf(patterns) === 'function') {
-    return filterValues(val, patterns, options);
+  if (typeof patterns === 'function') {
+    return filterValues(obj, patterns, options);
   }
 
-  var keys = filterKeys(val, patterns, options);
-  return pick(val, keys);
+  return glob(patterns, obj, options);
 };

package.json

 {
   "name": "filter-object",
   "description": "Filter an object by its keys or values. Returns a copy of an object filtered to have only keys or values that match the given glob patterns.",
-  "version": "2.1.0",
+  "version": "3.0.0",
   "homepage": "https://github.com/jonschlinkert/filter-object",
@@ -23,10 +23,9 @@ "author": "Jon Schlinkert (https://github.com/jonschlinkert)",
   "dependencies": {
-    "extend-shallow": "^2.0.1",
-    "filter-keys": "^1.0.2",
-    "filter-values": "^0.4.0",
-    "kind-of": "^2.0.1",
-    "object.pick": "^1.1.1"
+    "filter-values": "^0.4.1",
+    "glob-object": "^1.0.0",
+    "isobject": "^3.0.0"
   },
   "devDependencies": {
-    "mocha": "^2.2.1"
+    "gulp-format-md": "^0.1.12",
+    "mocha": "^3.4.2"
   },
@@ -65,4 +64,19 @@ "keywords": [
       ]
-    }
+    },
+    "toc": false,
+    "layout": "default",
+    "tasks": [
+      "readme"
+    ],
+    "plugins": [
+      "gulp-format-md"
+    ],
+    "lint": {
+      "reflinks": true
+    },
+    "reflinks": [
+      "filter-values",
+      "glob-object"
+    ]
   }
 }

README.md

@@ -1,2 +0,2 @@
-# filter-object [![NPM version](https://badge.fury.io/js/filter-object.svg)](http://badge.fury.io/js/filter-object)  [![Build Status](https://travis-ci.org/jonschlinkert/filter-object.svg)](https://travis-ci.org/jonschlinkert/filter-object)
+# filter-object [![NPM version](https://img.shields.io/npm/v/filter-object.svg?style=flat)](https://www.npmjs.com/package/filter-object) [![NPM monthly downloads](https://img.shields.io/npm/dm/filter-object.svg?style=flat)](https://npmjs.org/package/filter-object) [![NPM total downloads](https://img.shields.io/npm/dt/filter-object.svg?style=flat)](https://npmjs.org/package/filter-object) [![Linux Build Status](https://img.shields.io/travis/jonschlinkert/filter-object.svg?style=flat&label=Travis)](https://travis-ci.org/jonschlinkert/filter-object)
 
@@ -7,6 +7,6 @@ > Filter an object by its keys or values. Returns a copy of an object filtered to have only keys or values that match the given glob patterns.
 
-Install with [npm](https://www.npmjs.com/)
+Install with [npm](https://www.npmjs.com/):
 
 ```sh
-$ npm i filter-object --save
+$ npm install --save filter-object
 ```
@@ -21,20 +21,26 @@
 
-filter({a: 'a', b: 'b', c: 'c'}, '*');
+console.log(filter({a: 'a', b: 'b', c: 'c'}, '*'));
 //=> {a: 'a', b: 'b', c: 'c'}
 
-filter({a: 'a', b: 'b', c: 'c'}, 'b');
+console.log(filter({a: 'a', b: 'b', c: 'c'}, 'b'));
 //=> {b: 'b'}
 
-filter({foo: 'a', bar: 'b', baz: 'c'}, 'b*');
+console.log(filter({foo: 'a', bar: 'b', baz: 'c'}, 'b*'));
 //=> {bar: 'b', baz: 'c'}
 
-filter({a: 'a', b: 'b', c: 'c'}, '{b,c}');
+console.log(filter({a: 'a', b: 'b', c: 'c'}, '{b,c}'));
 //=> {b: 'b', c: 'c'}
+
+console.log(filter({a: 'a', b: 'b', c: 'c'}, ['a', 'b']));
+//=> {a: 'a', b: 'b'}
 ```
 
-Negation patterns work as well:
+**Negation patterns**
 
 ```js
-filter({foo: 'a', bar: 'b', baz: 'c'}, ['*', '!b*']);
-//=> {foo: 'a'}
+console.log(filter({foo: 'a', bar: 'b', baz: 'c'}, ['!b*']));
+//=> { foo: 'a' }
+
+console.log(filter({a: {b: {foo: 'a', bar: 'b', baz: 'c'}}}, ['!a.b.b*']));
+//=> {a: {b: {foo: 'a'}}}
 ```
@@ -44,3 +50,3 @@
 
-Pass options to [sort-object](https://github.com/doowb/sort-object) and/or [filter-keys](https://github.com/jonschlinkert/filter-keys)
+Options are passed to [glob-object](https://github.com/jonschlinkert/glob-object) and/or [filter-values](https://github.com/jonschlinkert/filter-values)
 
@@ -51,47 +57,50 @@ ```js
 
-See [sort-object](https://github.com/doowb/sort-object) for the full range of options and features.
+See [glob-object](https://github.com/jonschlinkert/glob-object) and/or [filter-values](https://github.com/jonschlinkert/filter-values) for the full range of options and available features.
 
-### Filter with a callback function
+## About
 
-```js
-filter({a: 'a', b: 'b', c: 'c'}, function(val) {
-  return val !== 'b';
-});
-//=> {a: 'a', c: 'c'}
-```
+### Related projects
 
-## Related
+* [filter-keys](https://www.npmjs.com/package/filter-keys): Filter the keys of an object using glob patterns. | [homepage](https://github.com/jonschlinkert/filter-keys "Filter the keys of an object using glob patterns.")
+* [filter-values](https://www.npmjs.com/package/filter-values): Filter an object values using glob patterns or with a `callback` function returns true.  | [homepage](https://github.com/jonschlinkert/filter-values "Filter an object values using glob patterns or with a `callback` function returns true. ")
+* [micromatch](https://www.npmjs.com/package/micromatch): Glob matching for javascript/node.js. A drop-in replacement and faster alternative to minimatch and multimatch. | [homepage](https://github.com/micromatch/micromatch "Glob matching for javascript/node.js. A drop-in replacement and faster alternative to minimatch and multimatch.")
+* [rename-keys](https://www.npmjs.com/package/rename-keys): Modify the names of the own enumerable properties (keys) of an object. | [homepage](https://github.com/jonschlinkert/rename-keys "Modify the names of the own enumerable properties (keys) of an object.")
+* [sort-object](https://www.npmjs.com/package/sort-object): Sort the keys in an object. | [homepage](https://github.com/doowb/sort-object "Sort the keys in an object.")
 
-* [filter-keys](https://www.npmjs.com/package/filter-keys): Filter the keys of an object using glob patterns. | [homepage](https://github.com/jonschlinkert/filter-keys)
-* [filter-values](https://www.npmjs.com/package/filter-values): Filter an object values using glob patterns or with a `callback` function returns true.  | [homepage](https://github.com/jonschlinkert/filter-values)
-* [micromatch](https://www.npmjs.com/package/micromatch): Glob matching for javascript/node.js. A drop-in replacement and faster alternative to minimatch and multimatch. Just… [more](https://www.npmjs.com/package/micromatch) | [homepage](https://github.com/jonschlinkert/micromatch)
-* [rename-keys](https://www.npmjs.com/package/rename-keys): Modify the names of the own enumerable properties (keys) of an object. | [homepage](https://github.com/jonschlinkert/rename-keys)
-* [sort-object](https://www.npmjs.com/package/sort-object): Sort the keys in an object. | [homepage](https://github.com/doowb/sort-object)
+### Contributing
 
-## Running tests
+Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
 
-Install dev dependencies:
+### Building docs
 
+_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_
+
+To generate the readme, run the following command:
+
 ```sh
-$ npm i -d && npm test
+$ npm install -g verbose/verb#dev verb-generate-readme && verb
 ```
 
-## Contributing
+### Running tests
 
-Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/jonschlinkert/filter-object/issues/new).
+Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:
 
-## Author
+```sh
+$ npm install && npm test
+```
 
+### Author
+
 **Jon Schlinkert**
 
-+ [github/jonschlinkert](https://github.com/jonschlinkert)
-+ [twitter/jonschlinkert](http://twitter.com/jonschlinkert)
+* [github/jonschlinkert](https://github.com/jonschlinkert)
+* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)
 
-## License
+### License
 
-Copyright © 2015 Jon Schlinkert
-Released under the MIT license.
+Copyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert).
+Released under the [MIT License](LICENSE).
 
 ***
 
-_This file was generated by [verb-cli](https://github.com/assemble/verb-cli) on September 08, 2015._
+_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on June 19, 2017._

No alert changes

Improved metrics

Total package byte prevSize

7484

24.55%

Dependency count

3

-40%

Number of lines in readme file

102

8.51%

Worsened metrics

Dev dependency count

2

100%

Lines of code

16

-5.88%

Dependency changes

• + Added

  glob-object@^1.0.0

• + Added

  isobject@^3.0.0

• + Added

  arr-diff@4.0.0
  (transitive)

• + Added

  arr-union@3.1.0
  (transitive)

• + Added

  arr-unique@1.0.2
  (transitive)

• + Added

  array-unique@0.3.2
  (transitive)

• + Added

  assign-symbols@1.0.0
  (transitive)

• + Added

  atob@2.1.2
  (transitive)

• + Added

  base@0.11.2
  (transitive)

• + Added

  braces@2.3.2
  (transitive)

• + Added

  cache-base@1.0.1
  (transitive)

• + Added

  class-utils@0.3.6
  (transitive)

• + Added

  clone-deep@0.3.0
  (transitive)

• + Added

  collection-visit@1.0.0
  (transitive)

• + Added

  component-emitter@1.3.1
  (transitive)

• + Added

  copy-descriptor@0.1.1
  (transitive)

• + Added

  debug@2.6.9
  (transitive)

• + Added

  decode-uri-component@0.2.2
  (transitive)

• + Added

  define-property@0.2.51.0.02.0.2
  (transitive)

• + Added

  expand-brackets@2.1.4
  (transitive)

• + Added

  extend-shallow@3.0.2
  (transitive)

• + Added

  extglob@2.0.4
  (transitive)

• + Added

  fill-range@4.0.0
  (transitive)

• + Added

  for-in@0.1.8
  (transitive)

• + Added

  for-own@1.0.0
  (transitive)

• + Added

  fragment-cache@0.2.1
  (transitive)

• + Added

  get-value@2.0.6
  (transitive)

• + Added

  glob-object@1.0.0
  (transitive)

• + Added

  has-value@0.3.11.0.0
  (transitive)

• + Added

  has-values@0.1.41.0.0
  (transitive)

• + Added

  is-accessor-descriptor@1.0.1
  (transitive)

• + Added

  is-data-descriptor@1.0.1
  (transitive)

• + Added

  is-descriptor@0.1.71.0.3
  (transitive)

• + Added

  is-extendable@1.0.1
  (transitive)

• + Added

  is-number@3.0.0
  (transitive)

• + Added

  is-plain-object@1.0.02.0.4
  (transitive)

• + Added

  is-windows@1.0.2
  (transitive)

• + Added

  isobject@0.2.0
  (transitive)

• + Added

  kind-of@4.0.0
  (transitive)

• + Added

  lazy-cache@0.2.7
  (transitive)

• + Added

  map-cache@0.2.2
  (transitive)

• + Added

  map-visit@1.0.0
  (transitive)

• + Added

  micromatch@3.1.10
  (transitive)

• + Added

  mixin-deep@1.3.2
  (transitive)

• + Added

  mixin-object@2.0.1
  (transitive)

• + Added

  ms@2.0.0
  (transitive)

• + Added

  nanomatch@1.2.13
  (transitive)

• + Added

  object-copy@0.1.0
  (transitive)

• + Added

  object-visit@1.0.1
  (transitive)

• + Added

  pascalcase@0.1.1
  (transitive)

• + Added

  posix-character-classes@0.1.1
  (transitive)

• + Added

  regex-not@1.0.2
  (transitive)

• + Added

  resolve-url@0.2.1
  (transitive)

• + Added

  ret@0.1.15
  (transitive)

• + Added

  safe-regex@1.1.0
  (transitive)

• + Added

  set-value@1.0.02.0.1
  (transitive)

• + Added

  shallow-clone@0.1.2
  (transitive)

• + Added

  snapdragon@0.8.2
  (transitive)

• + Added

  snapdragon-node@2.1.1
  (transitive)

• + Added

  snapdragon-util@3.0.1
  (transitive)

• + Added

  source-map@0.5.7
  (transitive)

• + Added

  source-map-resolve@0.5.3
  (transitive)

• + Added

  source-map-url@0.4.1
  (transitive)

• + Added

  split-string@3.1.0
  (transitive)

• + Added

  static-extend@0.1.2
  (transitive)

• + Added

  stringify-keys@0.3.0
  (transitive)

• + Added

  to-object-path@0.3.0
  (transitive)

• + Added

  to-regex@3.0.2
  (transitive)

• + Added

  to-regex-range@2.1.1
  (transitive)

• + Added

  union-value@1.0.1
  (transitive)

• + Added

  unset-value@1.0.0
  (transitive)

• + Added

  urix@0.1.0
  (transitive)

• + Added

  use@3.1.1
  (transitive)

• - Removed

  extend-shallow@^2.0.1

• - Removed

  filter-keys@^1.0.2

• - Removed

  kind-of@^2.0.1

• - Removed

  object.pick@^1.1.1

• - Removed

  filter-keys@1.1.0
  (transitive)

• Updated

  filter-values@^0.4.1