docs: correct ignore method names

fix #607 PR-URL: #608 Credit: @jedwards1211 Close: #608 Reviewed-by: @isaacs
isaacs · Sep 2, 2024 · 08958fa · 08958fa
1 parent feaf0a8
commit 08958fa
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -518,8 +518,8 @@ share the previously loaded cache.
   as modified time, permissions, and so on. Note that this will
   incur a performance cost due to the added system calls.
 
-- `ignore` string or string[], or an object with `ignore` and
-  `ignoreChildren` methods.
+- `ignore` string or string[], or an object with `ignored` and
+  `childrenIgnored` methods.
 
   If a string or string[] is provided, then this is treated as a
   glob pattern or array of glob patterns to exclude from matches.

diff --git a/src/glob.ts b/src/glob.ts
@@ -101,7 +101,7 @@ export interface GlobOptions {
   follow?: boolean
 
   /**
-   * string or string[], or an object with `ignore` and `ignoreChildren`
+   * string or string[], or an object with `ignored` and `childrenIgnored`
    * methods.
    *
    * If a string or string[] is provided, then this is treated as a glob