Skip to main content

Interface: TextDocument

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

Interface used to pass documents to the parser.

Since​

10.5.0

Extended by​

Properties​

text​

readonly text: string

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

the raw Document Text

url​

readonly url: string | URL

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

The associated URL for this document. Most documents have the file: protocol, indicating that they represent files on disk. However, some documents may have other protocols indicating that they are not available on disk.