Skip to main content

Interface: TextDocument

Defined in: packages/cspell-lib/src/lib/Models/TextDocument.ts:63

A simple text document. Not to be implemented. The document keeps the content as string.

Properties​

languageId​

readonly languageId: string | string[]

Defined in: packages/cspell-lib/src/lib/Models/TextDocument.ts:73

The identifier of the language associated with this document.

locale?​

readonly optional locale: string

Defined in: packages/cspell-lib/src/lib/Models/TextDocument.ts:87

The natural language locale.

text​

readonly text: string

Defined in: packages/cspell-lib/src/lib/Models/TextDocument.ts:82

the raw Document Text

uri​

readonly uri: DocumentUri

Defined in: packages/cspell-lib/src/lib/Models/TextDocument.ts:69

The associated URI for this document. Most documents have the file-scheme, indicating that they represent files on disk. However, some documents may have other schemes indicating that they are not available on disk.

version​

readonly version: number

Defined in: packages/cspell-lib/src/lib/Models/TextDocument.ts:78

The version number of this document (it will increase after each change, including undo/redo).

Methods​

getLine()​

getLine(lineNum): TextDocumentLine

Defined in: packages/cspell-lib/src/lib/Models/TextDocument.ts:92

Parameters​

lineNum​

number

Returns​

TextDocumentLine

getLines()​

getLines(): Iterable<TextDocumentLine>

Defined in: packages/cspell-lib/src/lib/Models/TextDocument.ts:93

Returns​

Iterable<TextDocumentLine>

lineAt()​

lineAt(offset): TextDocumentLine

Defined in: packages/cspell-lib/src/lib/Models/TextDocument.ts:91

Parameters​

offset​

number

Returns​

TextDocumentLine

offsetAt()​

offsetAt(position): number

Defined in: packages/cspell-lib/src/lib/Models/TextDocument.ts:90

Parameters​

position​

Position

Returns​

number

positionAt()​

positionAt(offset): Position

Defined in: packages/cspell-lib/src/lib/Models/TextDocument.ts:89

Parameters​

offset​

number

Returns​

Position