Class WriteReport

Everything a writer adjusted. Mirrors report.py's WriteReport.

Python's WriteReport.__bool__ returns not self.errors, so if check_toml(doc): ... reads as "safe". JS has no boolean-coercion operator overload, so that's exposed here as the explicit ok getter instead -- same truth table, called out rather than implicit.

Index

Constructors

Properties

Accessors

errors length ok warnings

Methods

[iterator] add toString

Constructors

constructor

new WriteReport(): WriteReport

Returns WriteReport

Properties

`Readonly`adjustments

adjustments: Adjustment[] = []

All adjustments recorded during write operations.

Accessors

errors

get errors(): Adjustment[]
Filtered list of adjustments with "error" severity.

Returns Adjustment[]
- Defined in src/report.ts:65

length

get length(): number
Total count of recorded adjustments.

Returns number
- Defined in src/report.ts:75

ok

get ok(): boolean
true iff there are no error-severity entries (warnings are fine).

Returns boolean
- Defined in src/report.ts:70

warnings

get warnings(): Adjustment[]
Filtered list of adjustments with "warning" severity.

Returns Adjustment[]
- Defined in src/report.ts:60

Methods

[iterator]

"[iterator]"(): Iterator<Adjustment>
Returns an iterator over all recorded adjustments.

Returns Iterator<Adjustment>
- Defined in src/report.ts:80

add

add(path: string, code: string, message: string, severity: Severity): void
Record an adjustment into this report.
Parameters
- path: string
- code: string
- message: string
- severity: Severity
Returns void
- Defined in src/report.ts:55

toString

toString(): string
Formats all adjustments into a human-readable multi-line string.

Returns string
- Defined in src/report.ts:85