Class DistanceCondition

constructor

• new DistanceCondition(tsConfigFilePath, metric, threshold, comparison, targetFile?, targetFolder?): DistanceCondition

• Parameters

  • tsConfigFilePath: undefined | string
  • metric: DistanceMetric
  • threshold: number
  • comparison: MetricComparison
  • Optional targetFile: string
  • Optional targetFolder: string

  Returns DistanceCondition

Readonly tsConfigFilePath

Readonly metric

Readonly threshold

Readonly comparison

Optional Readonly targetFile

Optional Readonly targetFolder

check

• check(options?): Promise<Violation[]>

• Check if files violate the distance metric condition

  Parameters

  • Optional options: CheckOptions

  Returns Promise<Violation[]>