summaryrefslogtreecommitdiff
path: root/src/node_modules/multimatch/index.d.ts
blob: ecddcdc5a44d960bc3a0e37761c83600f44494c5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
import {IOptions} from 'minimatch';

declare namespace multimatch {
	type Options = Readonly<IOptions>;
}

/**
Extends [`minimatch.match()`](https://github.com/isaacs/minimatch#minimatchmatchlist-pattern-options) with support for multiple patterns.

@param paths - Paths to match against.
@param patterns - Globbing patterns to use. For example: `['*', '!cake']`. See supported [`minimatch` patterns](https://github.com/isaacs/minimatch#usage).
@returns The matching paths in the order of input paths.

@example
```
import multimatch = require('multimatch');

multimatch(['unicorn', 'cake', 'rainbows'], ['*', '!cake']);
//=> ['unicorn', 'rainbows']
```
*/
declare function multimatch(
	paths: string | readonly string[],
	patterns: string | readonly string[],
	options?: multimatch.Options
): string[];

export = multimatch;