├── .editorconfig ├── .eslintrc.json ├── .gitattributes ├── .gitignore ├── .travis.yml ├── .verb.md ├── LICENSE ├── README.md ├── index.js ├── package.json └── test.js /.editorconfig: -------------------------------------------------------------------------------- 1 | root = true 2 | 3 | [*] 4 | indent_style = space 5 | end_of_line = lf 6 | charset = utf-8 7 | indent_size = 2 8 | trim_trailing_whitespace = true 9 | insert_final_newline = true 10 | 11 | [{**/{actual,fixtures,expected,templates}/**,*.md}] 12 | trim_trailing_whitespace = false 13 | insert_final_newline = false -------------------------------------------------------------------------------- /.eslintrc.json: -------------------------------------------------------------------------------- 1 | { 2 | "ecmaFeatures": { 3 | "modules": true, 4 | "experimentalObjectRestSpread": true 5 | }, 6 | 7 | "env": { 8 | "browser": false, 9 | "es6": true, 10 | "node": true, 11 | "mocha": true 12 | }, 13 | 14 | "globals": { 15 | "document": false, 16 | "navigator": false, 17 | "window": false 18 | }, 19 | 20 | "rules": { 21 | "accessor-pairs": 2, 22 | "arrow-spacing": [2, { "before": true, "after": true }], 23 | "block-spacing": [2, "always"], 24 | "brace-style": [2, "1tbs", { "allowSingleLine": true }], 25 | "comma-dangle": [2, "never"], 26 | "comma-spacing": [2, { "before": false, "after": true }], 27 | "comma-style": [2, "last"], 28 | "constructor-super": 2, 29 | "curly": [2, "multi-line"], 30 | "dot-location": [2, "property"], 31 | "eol-last": 2, 32 | "eqeqeq": [2, "allow-null"], 33 | "generator-star-spacing": [2, { "before": true, "after": true }], 34 | "handle-callback-err": [2, "^(err|error)$" ], 35 | "indent": [2, 2, { "SwitchCase": 1 }], 36 | "key-spacing": [2, { "beforeColon": false, "afterColon": true }], 37 | "keyword-spacing": [2, { "before": true, "after": true }], 38 | "new-cap": [2, { "newIsCap": true, "capIsNew": false }], 39 | "new-parens": 2, 40 | "no-array-constructor": 2, 41 | "no-caller": 2, 42 | "no-class-assign": 2, 43 | "no-cond-assign": 2, 44 | "no-const-assign": 2, 45 | "no-control-regex": 2, 46 | "no-debugger": 2, 47 | "no-delete-var": 2, 48 | "no-dupe-args": 2, 49 | "no-dupe-class-members": 2, 50 | "no-dupe-keys": 2, 51 | "no-duplicate-case": 2, 52 | "no-empty-character-class": 2, 53 | "no-eval": 2, 54 | "no-ex-assign": 2, 55 | "no-extend-native": 2, 56 | "no-extra-bind": 2, 57 | "no-extra-boolean-cast": 2, 58 | "no-extra-parens": [2, "functions"], 59 | "no-fallthrough": 2, 60 | "no-floating-decimal": 2, 61 | "no-func-assign": 2, 62 | "no-implied-eval": 2, 63 | "no-inner-declarations": [2, "functions"], 64 | "no-invalid-regexp": 2, 65 | "no-irregular-whitespace": 2, 66 | "no-iterator": 2, 67 | "no-label-var": 2, 68 | "no-labels": 2, 69 | "no-lone-blocks": 2, 70 | "no-mixed-spaces-and-tabs": 2, 71 | "no-multi-spaces": 2, 72 | "no-multi-str": 2, 73 | "no-multiple-empty-lines": [2, { "max": 1 }], 74 | "no-native-reassign": 0, 75 | "no-negated-in-lhs": 2, 76 | "no-new": 2, 77 | "no-new-func": 2, 78 | "no-new-object": 2, 79 | "no-new-require": 2, 80 | "no-new-wrappers": 2, 81 | "no-obj-calls": 2, 82 | "no-octal": 2, 83 | "no-octal-escape": 2, 84 | "no-proto": 0, 85 | "no-redeclare": 2, 86 | "no-regex-spaces": 2, 87 | "no-return-assign": 2, 88 | "no-self-compare": 2, 89 | "no-sequences": 2, 90 | "no-shadow-restricted-names": 2, 91 | "no-spaced-func": 2, 92 | "no-sparse-arrays": 2, 93 | "no-this-before-super": 2, 94 | "no-throw-literal": 2, 95 | "no-trailing-spaces": 0, 96 | "no-undef": 2, 97 | "no-undef-init": 2, 98 | "no-unexpected-multiline": 2, 99 | "no-unneeded-ternary": [2, { "defaultAssignment": false }], 100 | "no-unreachable": 2, 101 | "no-unused-vars": [2, { "vars": "all", "args": "none" }], 102 | "no-useless-call": 0, 103 | "no-with": 2, 104 | "one-var": [0, { "initialized": "never" }], 105 | "operator-linebreak": [0, "after", { "overrides": { "?": "before", ":": "before" } }], 106 | "padded-blocks": [0, "never"], 107 | "quotes": [2, "single", "avoid-escape"], 108 | "radix": 2, 109 | "semi": [2, "always"], 110 | "semi-spacing": [2, { "before": false, "after": true }], 111 | "space-before-blocks": [2, "always"], 112 | "space-before-function-paren": [2, "never"], 113 | "space-in-parens": [2, "never"], 114 | "space-infix-ops": 2, 115 | "space-unary-ops": [2, { "words": true, "nonwords": false }], 116 | "spaced-comment": [0, "always", { "markers": ["global", "globals", "eslint", "eslint-disable", "*package", "!", ","] }], 117 | "use-isnan": 2, 118 | "valid-typeof": 2, 119 | "wrap-iife": [2, "any"], 120 | "yoda": [2, "never"] 121 | } 122 | } 123 | -------------------------------------------------------------------------------- /.gitattributes: -------------------------------------------------------------------------------- 1 | # Enforce Unix newlines 2 | * text eol=lf 3 | 4 | # binaries 5 | *.ai binary 6 | *.psd binary 7 | *.jpg binary 8 | *.gif binary 9 | *.png binary 10 | *.jpeg binary -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # always ignore files 2 | *.DS_Store 3 | *.sublime-* 4 | 5 | # test related, or directories generated by tests 6 | test/actual 7 | actual 8 | coverage 9 | .nyc* 10 | 11 | # npm 12 | node_modules 13 | npm-debug.log 14 | 15 | # yarn 16 | yarn.lock 17 | yarn-error.log 18 | 19 | # misc 20 | _gh_pages 21 | _draft 22 | _drafts 23 | bower_components 24 | vendor 25 | temp 26 | tmp 27 | TODO.md 28 | 29 | examples/*/dist 30 | examples/*/site 31 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | sudo: false 2 | os: 3 | - linux 4 | - osx 5 | language: node_js 6 | node_js: 7 | - node 8 | - '7' 9 | - '6' 10 | - '5' 11 | - '4' 12 | - '2.1' 13 | - '2' 14 | - '1.8' 15 | - '1' 16 | - '0.12' 17 | - '0.10' 18 | git: 19 | depth: 10 20 | -------------------------------------------------------------------------------- /.verb.md: -------------------------------------------------------------------------------- 1 | ## Usage 2 | 3 | ```js 4 | var filter = require('{%= name %}'); 5 | 6 | filter({a: 'a', b: 'b', c: 'c'}, function(value, key, obj) { 7 | return key !== 'b'; 8 | }); 9 | //=> {a: 'a', c: 'c'} 10 | 11 | filter({a: 'a', b: 'b', c: 'c'}, function(value, key, obj) { 12 | return key === 'b'; 13 | }); 14 | //=> {b: 'b'} 15 | 16 | filter({a: 'a', b: 'b', c: 'c'}, function(value, key, obj) { 17 | return value === 'b'; 18 | }); 19 | //=> {b: 'b'} 20 | 21 | filter({a: 'a', b: 'bbd', c: 'bca2'}, ['b*', '!bc*']) 22 | //=> {b: 'bbd'} 23 | 24 | filter({a: 'a', b: 'bbd', c: 'bca2'}, '!b*') 25 | //=> {a: 'a'} 26 | ``` -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | The MIT License (MIT) 2 | 3 | Copyright (c) 2015, 2017, Jon Schlinkert 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in 13 | all copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN 21 | THE SOFTWARE. 22 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # filter-values [![NPM version](https://img.shields.io/npm/v/filter-values.svg?style=flat)](https://www.npmjs.com/package/filter-values) [![NPM monthly downloads](https://img.shields.io/npm/dm/filter-values.svg?style=flat)](https://npmjs.org/package/filter-values) [![NPM total downloads](https://img.shields.io/npm/dt/filter-values.svg?style=flat)](https://npmjs.org/package/filter-values) [![Linux Build Status](https://img.shields.io/travis/jonschlinkert/filter-values.svg?style=flat&label=Travis)](https://travis-ci.org/jonschlinkert/filter-values) 2 | 3 | > Filter an object values using glob patterns or with a `callback` function returns true. 4 | 5 | ## Install 6 | 7 | Install with [npm](https://www.npmjs.com/): 8 | 9 | ```sh 10 | $ npm install --save filter-values 11 | ``` 12 | 13 | Install with [yarn](https://yarnpkg.com): 14 | 15 | ```sh 16 | $ yarn add filter-values 17 | ``` 18 | 19 | ## Usage 20 | 21 | ```js 22 | var filter = require('filter-values'); 23 | 24 | filter({a: 'a', b: 'b', c: 'c'}, function(value, key, obj) { 25 | return key !== 'b'; 26 | }); 27 | //=> {a: 'a', c: 'c'} 28 | 29 | filter({a: 'a', b: 'b', c: 'c'}, function(value, key, obj) { 30 | return key === 'b'; 31 | }); 32 | //=> {b: 'b'} 33 | 34 | filter({a: 'a', b: 'b', c: 'c'}, function(value, key, obj) { 35 | return value === 'b'; 36 | }); 37 | //=> {b: 'b'} 38 | 39 | filter({a: 'a', b: 'bbd', c: 'bca2'}, ['b*', '!bc*']) 40 | //=> {b: 'bbd'} 41 | 42 | filter({a: 'a', b: 'bbd', c: 'bca2'}, '!b*') 43 | //=> {a: 'a'} 44 | ``` 45 | 46 | ## About 47 | 48 | ### Related projects 49 | 50 | * [filter-object](https://www.npmjs.com/package/filter-object): Filter an object by its keys or values. Returns a copy of an object filtered… [more](https://github.com/jonschlinkert/filter-object) | [homepage](https://github.com/jonschlinkert/filter-object "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.") 51 | * [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. ") 52 | * [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/jonschlinkert/micromatch "Glob matching for javascript/node.js. A drop-in replacement and faster alternative to minimatch and multimatch.") 53 | * [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.") 54 | * [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.") 55 | 56 | ### Contributing 57 | 58 | Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new). 59 | 60 | ### Contributors 61 | 62 | | **Commits** | **Contributor** | 63 | | --- | --- | 64 | | 13 | [jonschlinkert](https://github.com/jonschlinkert) | 65 | | 5 | [tunnckoCore](https://github.com/tunnckoCore) | 66 | | 3 | [someone235](https://github.com/someone235) | 67 | | 1 | [doowb](https://github.com/doowb) | 68 | 69 | ### Building docs 70 | 71 | _(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.)_ 72 | 73 | To generate the readme, run the following command: 74 | 75 | ```sh 76 | $ npm install -g verbose/verb#dev verb-generate-readme && verb 77 | ``` 78 | 79 | ### Running tests 80 | 81 | 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: 82 | 83 | ```sh 84 | $ npm install && npm test 85 | ``` 86 | 87 | ### Author 88 | 89 | **Jon Schlinkert** 90 | 91 | * [github/jonschlinkert](https://github.com/jonschlinkert) 92 | * [twitter/jonschlinkert](https://twitter.com/jonschlinkert) 93 | 94 | ### License 95 | 96 | Copyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert). 97 | Released under the [MIT License](LICENSE). 98 | 99 | *** 100 | 101 | _This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on May 11, 2017._ -------------------------------------------------------------------------------- /index.js: -------------------------------------------------------------------------------- 1 | /*! 2 | * filter-values 3 | * 4 | * Copyright (c) 2015, Jon Schlinkert. 5 | * Licensed under the MIT License. 6 | */ 7 | 8 | var forOwn = require('for-own'); 9 | var matcher = require('is-match'); 10 | 11 | /** 12 | * Filter an object values using glob patterns 13 | * or with a `callback` function returns true. 14 | * 15 | * @param {Object} `obj` 16 | * @param {Function|Array|String|RegExp} `filter` 17 | * @param {Object} `options` pass options to `micromatch` 18 | * @return {Object} 19 | */ 20 | 21 | module.exports = function filterValues(obj, filter, options) { 22 | var isMatch = matcher(filter, options); 23 | var res = {}; 24 | 25 | forOwn(obj, function (val, key) { 26 | if (isMatch(val, key, obj)) { 27 | res[key] = val; 28 | } 29 | }); 30 | return res; 31 | }; 32 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "filter-values", 3 | "description": "Filter an object values using glob patterns or with a `callback` function returns true. ", 4 | "version": "0.4.1", 5 | "homepage": "https://github.com/jonschlinkert/filter-values", 6 | "author": "Jon Schlinkert (https://github.com/jonschlinkert)", 7 | "contributors": [ 8 | "Jon Schlinkert (http://twitter.com/jonschlinkert)", 9 | "Charlike Mike Reagent (https://i.am.charlike.online)" 10 | ], 11 | "repository": "jonschlinkert/filter-values", 12 | "bugs": { 13 | "url": "https://github.com/jonschlinkert/filter-values/issues" 14 | }, 15 | "license": "MIT", 16 | "files": [ 17 | "index.js" 18 | ], 19 | "main": "index.js", 20 | "engines": { 21 | "node": ">=0.10.0" 22 | }, 23 | "scripts": { 24 | "test": "mocha" 25 | }, 26 | "dependencies": { 27 | "for-own": "^0.1.3", 28 | "is-match": "^0.4.0" 29 | }, 30 | "devDependencies": { 31 | "gulp-format-md": "^0.1.12", 32 | "mocha": "*", 33 | "should": "*" 34 | }, 35 | "keywords": [ 36 | "filter", 37 | "find", 38 | "glob", 39 | "globbing", 40 | "globs", 41 | "key", 42 | "keys", 43 | "match", 44 | "matcher", 45 | "minimatch", 46 | "obj", 47 | "object", 48 | "pattern", 49 | "patterns", 50 | "properties", 51 | "property", 52 | "props", 53 | "regex", 54 | "sort", 55 | "test", 56 | "wildcard" 57 | ], 58 | "verb": { 59 | "related": { 60 | "list": [ 61 | "filter-object", 62 | "filter-values", 63 | "micromatch", 64 | "rename-keys", 65 | "sort-object" 66 | ] 67 | }, 68 | "toc": false, 69 | "layout": "default", 70 | "tasks": [ 71 | "readme" 72 | ], 73 | "plugins": [ 74 | "gulp-format-md" 75 | ], 76 | "lint": { 77 | "reflinks": true 78 | } 79 | } 80 | } 81 | -------------------------------------------------------------------------------- /test.js: -------------------------------------------------------------------------------- 1 | /*! 2 | * filter-values 3 | * 4 | * Copyright (c) 2015, Jon Schlinkert. 5 | * Licensed under the MIT License. 6 | */ 7 | 8 | 'use strict'; 9 | 10 | /* deps:mocha */ 11 | var should = require('should'); 12 | var filter = require('./'); 13 | 14 | describe('.filter()', function () { 15 | it('should return values for which the callback returns true.', function () { 16 | var o = filter({a: 'a', b: 'b', c: 'c'}, function (value) { 17 | return value === 'b'; 18 | }); 19 | o.should.eql({ b: 'b' }); 20 | 21 | o = filter({a: 'a', b: 'b', c: 'c'}, function (value, key) { 22 | return key === 'b'; 23 | }); 24 | o.should.eql({ b: 'b' }); 25 | 26 | o = filter({a: 'a', b: 'b', c: 'c'}, function (value, key, obj) { 27 | return obj[key] === 'b'; 28 | }); 29 | o.should.eql({ b: 'b' }); 30 | }); 31 | 32 | it('should omit values for which the callback returns false.', function () { 33 | var o = filter({a: 'a', b: 'b', c: 'c'}, function (value) { 34 | return value !== 'b'; 35 | }); 36 | o.should.eql({a: 'a', c: 'c'}); 37 | }); 38 | 39 | it('should return an empty object if all values return false.', function () { 40 | var o = filter({a: 'a', b: 'b', c: 'c'}, function (value) { 41 | return value === 'foo'; 42 | }); 43 | o.should.eql({}); 44 | }); 45 | 46 | it('should work with `micromatch` glob patterns', function () { 47 | var o = filter({a: 'a', b: 'bbd', c: 'bca2'}, ['b*', '!bc*']); 48 | o.should.eql({b: 'bbd'}); 49 | 50 | var o = filter({a: 'a', b: 'bbd', c: 'bca2'}, '!b*'); 51 | o.should.eql({a: 'a'}) 52 | }); 53 | }); 54 | --------------------------------------------------------------------------------