Skip to main content

Interface: ProgressFileComplete

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

Extends​

Properties​

cached?​

optional cached?: boolean

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

true if the file was processed from the cache.

elapsedTimeMs​

elapsedTimeMs: number | undefined

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

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:199

The total number of files being processed.

Inherited from​

ProgressFileBase.fileCount

filename​

filename: string

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

The file name or href of file being processed.

Inherited from​

ProgressFileBase.filename

fileNum​

fileNum: number

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

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:233

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

numErrors​

numErrors: number | undefined

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

Number of errors and issues found in the file.

processed​

processed: boolean | undefined

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

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

reportIssueOptions?​

optional reportIssueOptions?: ReportIssueOptions

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

reportIssuesOptions to be used when reporting issues.

skippedReason?​

optional skippedReason?: string

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

Optional reason for skipping the file.

type​

type: "ProgressFileComplete"

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

Overrides​

ProgressFileBase.type