UNPKG

3.47 kBMarkdownView Raw
1# is-extglob [![NPM version](https://img.shields.io/npm/v/is-extglob.svg?style=flat)](https://www.npmjs.com/package/is-extglob) [![NPM downloads](https://img.shields.io/npm/dm/is-extglob.svg?style=flat)](https://npmjs.org/package/is-extglob) [![Build Status](https://img.shields.io/travis/jonschlinkert/is-extglob.svg?style=flat)](https://travis-ci.org/jonschlinkert/is-extglob)
2
3> Returns true if a string has an extglob.
4
5## Install
6
7Install with [npm](https://www.npmjs.com/):
8
9```sh
10$ npm install --save is-extglob
11```
12
13## Usage
14
15```js
16var isExtglob = require('is-extglob');
17```
18
19**True**
20
21```js
22isExtglob('?(abc)');
23isExtglob('@(abc)');
24isExtglob('!(abc)');
25isExtglob('*(abc)');
26isExtglob('+(abc)');
27```
28
29**False**
30
31Escaped extglobs:
32
33```js
34isExtglob('\\?(abc)');
35isExtglob('\\@(abc)');
36isExtglob('\\!(abc)');
37isExtglob('\\*(abc)');
38isExtglob('\\+(abc)');
39```
40
41Everything else...
42
43```js
44isExtglob('foo.js');
45isExtglob('!foo.js');
46isExtglob('*.js');
47isExtglob('**/abc.js');
48isExtglob('abc/*.js');
49isExtglob('abc/(aaa|bbb).js');
50isExtglob('abc/[a-z].js');
51isExtglob('abc/{a,b}.js');
52isExtglob('abc/?.js');
53isExtglob('abc.js');
54isExtglob('abc/def/ghi.js');
55```
56
57## History
58
59**v2.0**
60
61Adds support for escaping. Escaped exglobs no longer return true.
62
63## About
64
65### Related projects
66
67* [has-glob](https://www.npmjs.com/package/has-glob): Returns `true` if an array has a glob pattern. | [homepage](https://github.com/jonschlinkert/has-glob "Returns `true` if an array has a glob pattern.")
68* [is-glob](https://www.npmjs.com/package/is-glob): Returns `true` if the given string looks like a glob pattern or an extglob pattern… [more](https://github.com/jonschlinkert/is-glob) | [homepage](https://github.com/jonschlinkert/is-glob "Returns `true` if the given string looks like a glob pattern or an extglob pattern. This makes it easy to create code that only uses external modules like node-glob when necessary, resulting in much faster code execution and initialization time, and a bet")
69* [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.")
70
71### Contributing
72
73Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
74
75### Building docs
76
77_(This document was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme) (a [verb](https://github.com/verbose/verb) generator), please don't edit the readme directly. Any changes to the readme must be made in [.verb.md](.verb.md).)_
78
79To generate the readme and API documentation with [verb](https://github.com/verbose/verb):
80
81```sh
82$ npm install -g verb verb-generate-readme && verb
83```
84
85### Running tests
86
87Install dev dependencies:
88
89```sh
90$ npm install -d && npm test
91```
92
93### Author
94
95**Jon Schlinkert**
96
97* [github/jonschlinkert](https://github.com/jonschlinkert)
98* [twitter/jonschlinkert](http://twitter.com/jonschlinkert)
99
100### License
101
102Copyright © 2016, [Jon Schlinkert](https://github.com/jonschlinkert).
103Released under the [MIT license](https://github.com/jonschlinkert/is-extglob/blob/master/LICENSE).
104
105***
106
107_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.1.31, on October 12, 2016._
\No newline at end of file