Skip to main content

Interface: ProgressFileComplete

Defined in: cspell-types/dist/index.d.mts:145

Extends

Properties

cached?

optional cached: boolean

Defined in: cspell-types/dist/index.d.mts:164

true if the file was processed from the cache.


elapsedTimeMs

elapsedTimeMs: undefined | number

Defined in: cspell-types/dist/index.d.mts:151

The time it took to process the file in milliseconds. If undefined, then the elapsed time is not available.


fileCount

fileCount: number

Defined in: cspell-types/dist/index.d.mts:139

The total number of files being processed.

Inherited from

ProgressFileBase.fileCount


filename

filename: string

Defined in: cspell-types/dist/index.d.mts:143

The file name or href of file being processed.

Inherited from

ProgressFileBase.filename


fileNum

fileNum: number

Defined in: cspell-types/dist/index.d.mts:135

The sequence number of the file being processed.

Inherited from

ProgressFileBase.fileNum


issues?

optional issues: Iterable<Issue, any, any>

Defined in: cspell-types/dist/index.d.mts:169

Issues found in the file. If undefined, then the issues are not available.


numErrors

numErrors: undefined | number

Defined in: cspell-types/dist/index.d.mts:160

Number of errors and issues found in the file.


processed

processed: undefined | boolean

Defined in: cspell-types/dist/index.d.mts:156

true if the file was processed. false if the file was skipped.


reportIssueOptions?

optional reportIssueOptions: ReportIssueOptions

Defined in: cspell-types/dist/index.d.mts:173

reportIssuesOptions to be used when reporting issues.


type

type: "ProgressFileComplete"

Defined in: cspell-types/dist/index.d.mts:146

Overrides

ProgressFileBase.type