Class DistanceThresholdBuilder

constructor

• new DistanceThresholdBuilder(tsConfigFilePath, metric, targetFile?, targetFolder?): DistanceThresholdBuilder

• Parameters

  • tsConfigFilePath: undefined | string
  • metric: DistanceMetric
  • Optional targetFile: string
  • Optional targetFolder: string

  Returns DistanceThresholdBuilder

Readonly tsConfigFilePath

Readonly metric

Optional Readonly targetFile

Optional Readonly targetFolder

shouldBeAbove

• shouldBeAbove(threshold): DistanceCondition

• Metric should be above the specified threshold (>)

  Parameters

  • threshold: number

  Returns DistanceCondition

shouldBeBelow

• shouldBeBelow(threshold): DistanceCondition

• Metric should be below the specified threshold (<)

  Parameters

  • threshold: number

  Returns DistanceCondition

shouldEqual

• shouldEqual(threshold): DistanceCondition

• Metric should be equal to the specified threshold (=)

  Parameters

  • threshold: number

  Returns DistanceCondition

shouldBeAboveOrEqual

• shouldBeAboveOrEqual(threshold): DistanceCondition

• Metric should be at least the specified threshold (>=)

  Parameters

  • threshold: number

  Returns DistanceCondition

shouldBeBelowOrEqual

• shouldBeBelowOrEqual(threshold): DistanceCondition

• Metric should be at most the specified threshold (<=)

  Parameters

  • threshold: number

  Returns DistanceCondition