index.d.ts 1.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445
  1. interface Ignore {
  2. /**
  3. * Adds a rule rules to the current manager.
  4. * @param {string | Ignore} pattern
  5. * @returns IgnoreBase
  6. */
  7. add(pattern: string | Ignore): Ignore
  8. /**
  9. * Adds several rules to the current manager.
  10. * @param {string[]} patterns
  11. * @returns IgnoreBase
  12. */
  13. add(patterns: (string | Ignore)[]): Ignore
  14. /**
  15. * Filters the given array of pathnames, and returns the filtered array.
  16. * NOTICE that each path here should be a relative path to the root of your repository.
  17. * @param paths the array of paths to be filtered.
  18. * @returns The filtered array of paths
  19. */
  20. filter(paths: string[]): string[]
  21. /**
  22. * Creates a filter function which could filter
  23. * an array of paths with Array.prototype.filter.
  24. */
  25. createFilter(): (path: string) => boolean
  26. /**
  27. * Returns Boolean whether pathname should be ignored.
  28. * @param {string} pathname a path to check
  29. * @returns boolean
  30. */
  31. ignores(pathname: string): boolean
  32. }
  33. interface Options {
  34. ignorecase?: boolean
  35. }
  36. /**
  37. * Creates new ignore manager.
  38. */
  39. declare function ignore(options?: Options): Ignore
  40. export default ignore