Class TextAbstract

constructor

• new Text(): Text

  Returns Text

[iterator]

Abstract Readonlychildren

Abstract Readonlylength

Abstract Readonlylines

Staticempty

append

• append(other: Text): Text

  Append another document to this one.

  Parameters

  • other: Text

  Returns Text

eq

• eq(other: Text): boolean

  Test whether this text is equal to another instance.

  Parameters

  • other: Text

  Returns boolean

iter

• iter(dir?: -1 | 1): TextIterator

  Iterate over the text. When dir is -1, iteration happens from end to start. This will return lines and the breaks between them as separate strings.

  Parameters

  • Optionaldir: -1 | 1

  Returns TextIterator

iterLines

• iterLines(from?: number, to?: number): TextIterator

  Return a cursor that iterates over the given range of lines, without returning the line breaks between, and yielding empty strings for empty lines.

  When from and to are given, they should be 1-based line numbers.

  Parameters

  • Optionalfrom: number
  • Optionalto: number

  Returns TextIterator

iterRange

• iterRange(from: number, to?: number): TextIterator

  Iterate over a range of the text. When from > to, the iterator will run in reverse.

  Parameters

  • from: number
  • Optionalto: number

  Returns TextIterator

line

• line(n: number): Line

  Get the description for the given (1-based) line number.

  Parameters

  • n: number

  Returns Line

lineAt

• lineAt(pos: number): Line

  Get the line description around the given position.

  Parameters

  • pos: number

  Returns Line

replace

• replace(from: number, to: number, text: Text): Text

  Replace a range of the text with the given content.

  Parameters

  • from: number
  • to: number
  • text: Text

  Returns Text

slice

• slice(from: number, to?: number): Text

  Retrieve the text between the given points.

  Parameters

  • from: number
  • Optionalto: number

  Returns Text

AbstractsliceString

• sliceString(from: number, to?: number, lineSep?: string): string

  Retrieve a part of the document as a string

  Parameters

  • from: number
  • Optionalto: number
  • OptionallineSep: string

  Returns string

toJSON

• toJSON(): string[]

  Convert the document to an array of lines (which can be deserialized again via Text.of).

  Returns string[]

toString

• toString(): string

  Return the document as a string, using newline characters to separate lines.

  Returns string

Staticof

• of(text: readonly string[]): Text

  Create a Text instance for the given array of lines.

  Parameters

  • text: readonly string[]

  Returns Text