Skip to main content

Interface: ProgressFileComplete

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

Extends​

Properties​

cached?​

optional cached?: boolean

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

true if the file was processed from the cache.

elapsedTimeMs​

elapsedTimeMs: number | undefined

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

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

fileCount​

fileCount: number

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

The total number of files being processed.

Inherited from​

ProgressFileBase.fileCount

filename​

filename: string

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

The file name or href of file being processed.

Inherited from​

ProgressFileBase.filename

fileNum​

fileNum: number

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

The sequence number of the file being processed.

Inherited from​

ProgressFileBase.fileNum

issues?​

optional issues?: Iterable<Issue, any, any>

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

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

numErrors​

numErrors: number | undefined

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

Number of errors and issues found in the file.

processed​

processed: boolean | undefined

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

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

reportIssueOptions?​

optional reportIssueOptions?: ReportIssueOptions

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

reportIssuesOptions to be used when reporting issues.

skippedReason?​

optional skippedReason?: string

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

Optional reason for skipping the file.

type​

type: "ProgressFileComplete"

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

Overrides​

ProgressFileBase.type