JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 15701
  • Score
    100M100P100Q119850F
  • License MIT

Create a matching function from a glob pattern, regex, string, array, object or function.

Package Exports

  • is-match

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 (is-match) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

is-match NPM version NPM downloads Build Status

Create a matching function from a glob pattern, regex, string, array, object or function.

Install

Install with npm:

$ npm install is-match --save

Usage

var isMatch = require('is-match');

Create matchers:

from a string:

var isMatch = matcher('a')

isMatch('a');
//=> true

isMatch('b');
//=> false

from a glob pattern:

var isMatch = matcher('*')
isMatch('a'); //=> true

var isMatch = matcher('!b')
isMatch('a'); //=> true

var isMatch = matcher('!b')
isMatch('b'); //=> false

from an array of glob patterns:

var isMatch = matcher(['b'])
isMatch('a'); //=> false

var isMatch = matcher(['b', 'a'])
isMatch('a'); //=> true

var isMatch = matcher(['b', 'c', '*'])
isMatch('a'); //=> true

from a regex:

var isMatch = matcher(/a/);

isMatch('a');
//=> true

isMatch('b');
//=> false

from a function:

var isMatch = matcher(function  (val) {
  return val === 'a';
});
isMatch('a');
//=> true

isMatch('b');
//=> false

from an object:

var isMatch = matcher({a: 'b'});

isMatch({a: 'b'}); //=> true
isMatch({a: 'b', c: 'd'}); //=> false
isMatch({e: 'f', c: 'd'}); //=> false

You might also be interested in these projects:

  • 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 or an extglob pattern.… more | homepage
  • micromatch: Glob matching for javascript/node.js. A drop-in replacement and faster alternative to minimatch and multimatch. Just… more | homepage

Contributing

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

Building docs

Generate readme and API documentation with verb:

$ npm install verb && npm run docs

Or, if verb is installed globally:

$ verb

Running tests

Install dev dependencies:

$ npm install -d && npm test

Author

Jon Schlinkert

License

Copyright © 2016, Jon Schlinkert. Released under the MIT license.

This file was generated by verb, v0.9.0, on April 20, 2016.