Merge pull request #70 from nicojs/patch-1

kaelzhang · web-flow · commit 7785ba863b40 · 2021-12-19T11:08:41.000+08:00
fix(types): allow for readonly arrays
diff --git a/index.d.ts b/index.d.ts
@@ -7,25 +7,20 @@ interface TestResult {
 
 export interface Ignore {
   /**
-   * Adds a rule rules to the current manager.
-   * @param  {string | Ignore} pattern
-   * @returns IgnoreBase
-   */
-  add(pattern: string | Ignore): this
-  /**
-   * Adds several rules to the current manager.
+   * Adds one or several rules to the current manager.
    * @param  {string[]} patterns
    * @returns IgnoreBase
    */
-  add(patterns: (string | Ignore)[]): this
+  add(patterns: string | Ignore | readonly (string | Ignore)[]): this
 
   /**
    * 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(pathnames: Pathname[]): Pathname[]
+  filter(pathnames: readonly Pathname[]): Pathname[]
+  
   /**
    * Creates a filter function which could filter
    * an array of paths with Array.prototype.filter.
