google_forms/node_modules/ignore/index.d.ts

62 lines
1.5 KiB
TypeScript
Raw Permalink Normal View History

2024-08-21 06:34:30 +00:00
type Pathname = string
interface TestResult {
ignored: boolean
unignored: boolean
}
export interface Ignore {
2024-08-09 12:04:48 +00:00
/**
2024-08-21 06:34:30 +00:00
* Adds one or several rules to the current manager.
2024-08-09 12:04:48 +00:00
* @param {string[]} patterns
* @returns IgnoreBase
*/
2024-08-21 06:34:30 +00:00
add(patterns: string | Ignore | readonly (string | Ignore)[]): this
2024-08-09 12:04:48 +00:00
/**
* 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
*/
2024-08-21 06:34:30 +00:00
filter(pathnames: readonly Pathname[]): Pathname[]
2024-08-09 12:04:48 +00:00
/**
* Creates a filter function which could filter
* an array of paths with Array.prototype.filter.
*/
2024-08-21 06:34:30 +00:00
createFilter(): (pathname: Pathname) => boolean
2024-08-09 12:04:48 +00:00
/**
* Returns Boolean whether pathname should be ignored.
* @param {string} pathname a path to check
* @returns boolean
*/
2024-08-21 06:34:30 +00:00
ignores(pathname: Pathname): boolean
/**
* Returns whether pathname should be ignored or unignored
* @param {string} pathname a path to check
* @returns TestResult
*/
test(pathname: Pathname): TestResult
2024-08-09 12:04:48 +00:00
}
2024-08-21 06:34:30 +00:00
export interface Options {
2024-08-09 12:04:48 +00:00
ignorecase?: boolean
2024-08-21 06:34:30 +00:00
// For compatibility
ignoreCase?: boolean
allowRelativePaths?: boolean
2024-08-09 12:04:48 +00:00
}
/**
* Creates new ignore manager.
*/
declare function ignore(options?: Options): Ignore
2024-08-21 06:34:30 +00:00
declare namespace ignore {
export function isPathValid (pathname: string): boolean
}
2024-08-09 12:04:48 +00:00
export default ignore