Class DistanceCondition

constructor

• new DistanceCondition(
      tsConfigFilePath: string | undefined,
      metric: DistanceMetric,
      threshold: number,
      comparison: MetricComparison,
      targetFile?: string,
      targetFolder?: string,
  ): DistanceCondition

  Parameters

  • tsConfigFilePath: string | undefined
  • metric: DistanceMetric
  • threshold: number
  • comparison: MetricComparison
  • OptionaltargetFile: string
  • OptionaltargetFolder: string

  Returns DistanceCondition

ReadonlytsConfigFilePath

Readonlymetric

Readonlythreshold

Readonlycomparison

Optional ReadonlytargetFile

Optional ReadonlytargetFolder

check

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

  Check if files violate the distance metric condition

  Parameters

  • Optionaloptions: CheckOptions

  Returns Promise<Violation[]>