Interface: DocumentParser

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

Properties

name

readonly name: string

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

Name of parser

---

parse?

optional parse?: (content, filename) => ParseResult

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

Parse Method

Parameters

content

string

full content of the file

filename

string

filename

Returns

ParseResult

---

parseDocument

parseDocument: ParseDocument

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

Parse Method

Param

document

the text document to parse