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: string | undefined,
    zoneType: "zone-of-pain" | "zone-of-uselessness",
    targetFile?: string,
    targetFolder?: string,
): ZoneCondition
Parameters
- tsConfigFilePath: string | undefined
- zoneType: "zone-of-pain" | "zone-of-uselessness"
- OptionaltargetFile: string
- OptionaltargetFolder: string
Returns ZoneCondition
- Defined in metrics/fluentapi/metrics/distance-metrics.ts:390

Properties

`Readonly`tsConfigFilePath

tsConfigFilePath: string | undefined

`Readonly`zoneType

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

`Optional` `Readonly`targetFile

targetFile?: string

`Optional` `Readonly`targetFolder

targetFolder?: string

Methods

check

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