Skip to main content

Interface: TextDocument

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

Interface used to pass documents to the parser.

Since​

11.0.0

Extended by​

Properties​

text​

readonly text: string

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

the raw Document Text


url​

readonly url: string | URL

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

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.