Class Matcher

表示一个匹配器。

Hierarchy

Matcher

Index

Constructors

constructor

Properties

Accessors

base

Methods

Constructors

constructor

new Matcher(pattern?: Pattern, cwd?: string): Matcher

- Defined in lib/utility/matcher.ts:17
初始化新的匹配器。

Parameters
- Optional pattern: Pattern
  
  要添加的匹配模式。
- Optional cwd: string
  
  模式的根路径。默认当前工作文件夹。
Returns Matcher

Properties

Optional ignoreMatcher

ignoreMatcher: Matcher

当前匹配器的忽略匹配器。如果不存在则返回 undefined。

patterns

patterns: CompiledPattern[] = []

所有已编译的模式列表。

Accessors

base

get base(): string

- Defined in lib/utility/matcher.ts:103
获取所有模式的公共基路径。

Returns string

返回基路径。如果无法获取获取则返回 null。

Methods

add

add(pattern: Pattern, cwd?: string): void

- Defined in lib/utility/matcher.ts:35
添加一个匹配模式。

Parameters
- pattern: Pattern
  
  要添加的匹配模式。
- Optional cwd: string
  
  模式的根路径。默认当前工作文件夹。
Returns void

addIgnore

addIgnore(pattern: Pattern, cwd?: string): void

- Defined in lib/utility/matcher.ts:71
添加一个忽略模式。

Parameters
- pattern: Pattern
  
  要添加的模式。
- Optional cwd: string
  
  模式的根路径。默认当前工作文件夹。
Returns void

test

test(path: string): boolean

- Defined in lib/utility/matcher.ts:80
测试指定的绝对路径是否符合当前匹配器。

Parameters
- path: string
  
  要测试的绝对路径。
Returns boolean

如果匹配任意一个已添加的模式且未被忽略则返回 true，否则返回 false。

Static test

test(value: string, pattern: Pattern, cwd?: string): boolean

- Defined in lib/utility/matcher.ts:121
测试指定的内容是否符合指定的模式。

Parameters
- value: string
  
  要测试的内容。
- pattern: Pattern
  
  要测试的匹配模式。
- Optional cwd: string
  
  模式的根路径。默认当前工作文件夹。
Returns boolean

如果匹配则返回 true，否则返回 false。

Generated using TypeDoc