Class ZoneCondition

Condition for checking if components are in architectural zones

Implements

Checkable

Index

Constructors

Properties

tsConfigFilePath zoneType targetFile? targetFolder?

Methods

Constructors

constructor

new ZoneCondition(tsConfigFilePath, zoneType, targetFile?, targetFolder?): ZoneCondition
Parameters
- tsConfigFilePath: undefined | string
- zoneType: "zone-of-pain" | "zone-of-uselessness"
- Optional targetFile: string
- Optional targetFolder: string
Returns ZoneCondition
- Defined in src/metrics/fluentapi/metrics/distance-metrics.ts:390

Properties

`Readonly` tsConfigFilePath

tsConfigFilePath: undefined | string

`Readonly` zoneType

zoneType: "zone-of-pain" | "zone-of-uselessness"

`Optional` `Readonly` targetFile

targetFile?: string

`Optional` `Readonly` targetFolder

targetFolder?: string

Methods

check

check(options?): Promise<Violation[]>
Check if files are in the specified architectural zone
Parameters
- Optional options: CheckOptions
Returns Promise<Violation[]>
Implementation of Checkable.check
- Defined in src/metrics/fluentapi/metrics/distance-metrics.ts:400