Skip to content

removeAll

Remove all matching index entries.

Signature

ts
class Index {
  removeAll(pathspecs: string[], options?: IndexRemoveAllOptions): void;
}

Parameters

  • pathspecsrequired · string[]

    A List of file names of shell glob patterns that will matched against files in the repository's working directory

  • optionsnull | IndexRemoveAllOptions

    Options for remove all matching index entry.

    • onMatch(args: IndexOnMatchCallbackArgs) => number

      If you provide a callback function, it will be invoked on each matching item in the index immediately before it is removed. Return 0 to remove the item, > 0 to skip the item, and < 0 to abort the scan.

Released under the MIT License.