filter-array

Created: 2014-12-12 11:54
Updated: 2018-04-26 11:26
License: mit

README.md

filter-array NPM version

Iterates over the elements in an array, returning an array with only the elements for which the callback returns truthy.

Install with npm

npm i filter-array --save

Usage

filterArray

Filter array against given glob patterns, regex or given function.

Params

  • arr {Array}: array to filter
  • filters {Array|String|Function|RegExp}
  • opts {Object}: options to pass to micromatch
  • returns {Array}

Example

var filter = require('filter-array');

filter(['a', 'b', 'c', 'b', 'c', 'e'], function(ele) {
  return ele === 'a' || ele === 'b';
});

//=> ['a', 'b', 'b']

For more examples see the tests

Related

  • arr-filter: Faster alternative to javascript's native filter method.
  • filter-object: Return a copy of an object, filtered to have only keys that match the given… more
  • micromatch: Glob matching for javascript/node.js. A drop-in replacement and faster alternative to minimatch and multimatch. Just… more

Run Tests

Install dev dependencies:

npm i -d && npm test

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue

Author

Jon Schlinkert

License

Copyright (c) 2014-2015 Jon Schlinkert Released under the MIT license.


This file was generated by verb-cli on May 01, 2015.

Cookies help us deliver our services. By using our services, you agree to our use of cookies Learn more