100 lines
2.6 KiB
Markdown
100 lines
2.6 KiB
Markdown
|
|
||
|
|
# wildcard
|
||
|
|
|
||
|
|
Very simple wildcard matching, which is designed to provide the same
|
||
|
|
functionality that is found in the
|
||
|
|
[eve](https://github.com/adobe-webplatform/eve) eventing library.
|
||
|
|
|
||
|
|
|
||
|
|
[](https://nodei.co/npm/wildcard/)
|
||
|
|
|
||
|
|
[](https://travis-ci.org/DamonOehlman/wildcard) [](https://github.com/dominictarr/stability#stable)
|
||
|
|
|
||
|
|
## NOTE
|
||
|
|
|
||
|
|
Work on this project is largely inactive, now so I'd recommend checking out
|
||
|
|
the wonderful [`matcher`](https://github.com/sindresorhus/matcher) package
|
||
|
|
as a solid alternative.
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
It works with strings:
|
||
|
|
|
||
|
|
```js
|
||
|
|
var wildcard = require('wildcard');
|
||
|
|
|
||
|
|
console.log(wildcard('foo.*', 'foo.bar'));
|
||
|
|
// --> true
|
||
|
|
|
||
|
|
console.log(wildcard('foo.*', 'foo'));
|
||
|
|
// --> true
|
||
|
|
|
||
|
|
```
|
||
|
|
|
||
|
|
Arrays:
|
||
|
|
|
||
|
|
```js
|
||
|
|
var wildcard = require('wildcard');
|
||
|
|
var testdata = [
|
||
|
|
'a.b.c',
|
||
|
|
'a.b',
|
||
|
|
'a',
|
||
|
|
'a.b.d'
|
||
|
|
];
|
||
|
|
|
||
|
|
console.log(wildcard('a.b.*', testdata));
|
||
|
|
// --> ['a.b.c', 'a.b', 'a.b.d']
|
||
|
|
|
||
|
|
```
|
||
|
|
|
||
|
|
Objects (matching against keys):
|
||
|
|
|
||
|
|
```js
|
||
|
|
var wildcard = require('wildcard');
|
||
|
|
var testdata = {
|
||
|
|
'a.b.c' : {},
|
||
|
|
'a.b' : {},
|
||
|
|
'a' : {},
|
||
|
|
'a.b.d' : {}
|
||
|
|
};
|
||
|
|
|
||
|
|
console.log(wildcard('a.*.c', testdata));
|
||
|
|
// --> { 'a.b.c': {} }
|
||
|
|
|
||
|
|
```
|
||
|
|
|
||
|
|
## Alternative Implementations
|
||
|
|
|
||
|
|
- <https://github.com/isaacs/node-glob>
|
||
|
|
|
||
|
|
Great for full file-based wildcard matching.
|
||
|
|
|
||
|
|
- <https://github.com/sindresorhus/matcher>
|
||
|
|
|
||
|
|
A well cared for and loved JS wildcard matcher.
|
||
|
|
|
||
|
|
## License(s)
|
||
|
|
|
||
|
|
### MIT
|
||
|
|
|
||
|
|
Copyright (c) 2017 Damon Oehlman <damon.oehlman@gmail.com>
|
||
|
|
|
||
|
|
Permission is hereby granted, free of charge, to any person obtaining
|
||
|
|
a copy of this software and associated documentation files (the
|
||
|
|
'Software'), to deal in the Software without restriction, including
|
||
|
|
without limitation the rights to use, copy, modify, merge, publish,
|
||
|
|
distribute, sublicense, and/or sell copies of the Software, and to
|
||
|
|
permit persons to whom the Software is furnished to do so, subject to
|
||
|
|
the following conditions:
|
||
|
|
|
||
|
|
The above copyright notice and this permission notice shall be
|
||
|
|
included in all copies or substantial portions of the Software.
|
||
|
|
|
||
|
|
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
|
||
|
|
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
||
|
|
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
|
||
|
|
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
|
||
|
|
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
|
||
|
|
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
|
||
|
|
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|