Package Exports

matchkeys

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (matchkeys) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

matchkeys

Utility for returning a list of arrays that contain matching keywords. Useful for filtering package.json files.

Install

Install with npm:

npm i matchkeys --save-dev

Usage

var matchkeys = require('matchkeys');

matchkeys ( array, patterns, property )

Return an array of objects that contain arrays with matching strings. patterns may be glob patterns, strings, or an array of glob patterns or strings.

Example::

var arr = [
  {name: 'a', keywords: ['apple', 'orange', 'grape']},
  {name: 'b', keywords: ['banana', 'orange', 'pineapple']},
  {name: 'c', keywords: ['watermelon', 'strawberry', 'kiwi']},
  {name: 'd', keywords: ['watermelon', 'blah']},
  {name: 'e', keywords: ['watermelon', 'blah', 'lodash']},
];
console.log(matchkeys(arr, 'apple'));
//=> [{name: 'a', keywords: ['apple', 'orange', 'grape']}]

console.log(matchkeys(arr, 'o*'));
//=>
// [
//   {name: 'a', keywords: ['apple', 'orange', 'grape']},
//   {name: 'b', keywords: ['banana', 'orange', 'pineapple']}
// ]

Params:

array {Object|Array}:
patterns {String|Array}: The glob patterns or strings to use for matching.
prop {String}: Optionally pass the name of the property to search.
return {Array} Array of objects with matching strings.

matchkeys.filter ( array, patterns )

Wrapper around multimatch. Returns an array of matching strings, from an array or arrays of strings.

Example:

var keywords = [
  ['apple', 'orange', 'grape'],
  ['banana', 'orange', 'pineapple'],
  ['watermelon', 'strawberry', 'kiwi'],
  ['watermelon', 'blah'],
  ['watermelon', 'blah', 'lodash'],
];

console.log(matchkeys.filter(keywords, '{p,b}*'));
//=> ['banana', 'pineapple', 'blah']

Params:

array {Array}: Can be an array or an array of arrays.
pattern {Array|String}: The glob pattern to use.
return {Array}

Author

Jon Schlinkert

License

This file was generated by verb-cli on June 20, 2014.