Skip to main content

Interface: ParsedText

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

Extends​

  • Readonly<Mapped>

Properties​

delegate?​

readonly optional delegate?: DelegateInfo

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

Used to delegate parsing the contents of text to another parser.

map?​

readonly optional map?: SourceMap

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

(i, j) number pairs where

  • i is the offset in the source relative to the start of the range
  • j is the offset in the transformed destination

Example:

  • source text = "caf\xe9"
  • mapped text = "café"
  • map = [3, 3, 4, 1]

See: SourceMap

Inherited from​

Readonly.map

range​

readonly range: Range

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

The absolute start and end offset of the text in the source.

Inherited from​

Readonly.range

rawText?​

readonly optional rawText?: string

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

The raw text before it has been transformed

scope?​

readonly optional scope?: Scope

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

The Scope annotation for a segment of text. Used by the spell checker to apply spell checking options based upon the value of the scope.

tags?​

readonly optional tags?: Readonly<ParsedTags>

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

The tags associated with this segment of text.

text​

readonly text: string

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

The text extracted and possibly transformed