Home > harper.js > Summary

Summary interface

Represents the summary of linting results.

Signature:

export declare interface Summary 

Properties

Property

Modifiers

Type

Description

lint_counts

Record<string, number>

An object mapping each lint type to its count. Example: { "Spelling": 4, "Capitalization": 1 }

misspelled

Record<string, number>

An object mapping misspelled words to their occurrence counts. Example: { "mispelled": 1, "mispell": 1, "thigs": 2 }

total_applied

number

The total number of fixes applied.