Blame view

node_modules/ignore/index.d.ts 1.06 KB
aaac7fed   liuqimichale   add
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
29
30
31
32
33
34
35
36
37
38
39
40
41
  interface Ignore {
    /**
     * Adds a rule rules to the current manager.
     * @param  {string | Ignore} pattern
     * @returns IgnoreBase
     */
    add(pattern: string | Ignore): Ignore
    /**
     * Adds several rules to the current manager.
     * @param  {string[]} patterns
     * @returns IgnoreBase
     */
    add(patterns: (string | Ignore)[]): Ignore
  
    /**
     * Filters the given array of pathnames, and returns the filtered array.
     * NOTICE that each path here should be a relative path to the root of your repository.
     * @param paths the array of paths to be filtered.
     * @returns The filtered array of paths
     */
    filter(paths: string[]): string[]
    /**
     * Creates a filter function which could filter
     * an array of paths with Array.prototype.filter.
     */
    createFilter(): (path: string) => boolean
  
    /**
     * Returns Boolean whether pathname should be ignored.
     * @param  {string} pathname a path to check
     * @returns boolean
     */
    ignores(pathname: string): boolean
  }
  
  /**
   * Creates new ignore manager.
   */
  declare function ignore(): Ignore
  
  export default ignore