match-key

match-key

Get a property from an object with the first key that matches the given glob pattern, function, regex or string.

This returns one property. If you want to filter an object use [filter-object].

Install with npm

$ npm i match-key --save

Usage

var matchKey = require('match-key');
matchKey(object, pattern, options);

Params:

• object: The object to search
• pattern: The pattern to match against. This may be string, function, glob pattern, or regex.
• options: options to pass to micromatch

Valid patterns

String:

matchKey({a: 'b', c: 'd'}, 'a');
//=> {a: 'b'}

Function:

matchKey({a: 'b', c: 'd'}, function (key) {
  return key === 'a'
});
//=> {'a': 'b'}

Glob pattern:

matchKey(o, '*');
//=> {a: 'b'}

matchKey(o, '*c');
//=> {c: 'd'}

Regular expression:

matchKey({a: 'b', aa: 'bb'}, /\w{2}/);
//=> {aa: 'bb'}

Related

• has-glob: Returns true if an array has a glob pattern. | homepage
• is-glob: Returns true if the given string looks like a glob pattern. | homepage
• is-match: Create a matching function from a glob pattern, regex, string, array, object or function. | homepage
• micromatch: Glob matching for javascript/node.js. A drop-in replacement and faster alternative to minimatch and multimatch. Just… more | homepage

Running 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

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2015 Jon Schlinkert Released under the MIT license.

This file was generated by verb-cli on September 08, 2015.