Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TextDocument

表示一个文本文档，用于多次修改并生成新文本内容和源映射（Source Map）

Hierarchy

  • TextDocument

Index

Constructors

Properties

Methods

Constructors

constructor

  • 初始化新的文档

    Parameters

    • content: string

      文档的原始内容

    • Optional path: string

      文档的原始路径

    • Optional sourceMap: SourceMapData

      文档的原始源映射

    Returns TextDocument

Properties

content

content: string

获取文档的原始内容

Optional path

path: string

获取文档的原始路径

replacements

replacements: object[] = []

获取所有替换记录

Optional sourceMap

sourceMap: SourceMapBuilder

获取文档的原始源映射

Methods

append

  • append(content: string | object | function): object

  • 在文档末尾插入内容

    Parameters

    • content: string | object | function

      要插入的内容，如果是函数则为最后根据生成目标自动计算的内容

    Returns object

    返回替换记录

generate

  • 生成最终文本内容和源映射

    Parameters

    • Rest ...args: any[]

      传递给计算内容的函数参数

    Returns SourceMapTextWriter

insert

  • insert(index: number, content: string | object | function): object

  • 在文档中指定位置插入内容

    Parameters

    • index: number

      要插入的索引

    • content: string | object | function

      要插入的内容，如果是函数则为最后根据生成目标自动计算的内容

    Returns object

    返回替换记录

remove

  • remove(startIndex: number, endIndex: number): object

  • 删除文档中指定区间的内容

    Parameters

    • startIndex: number

      要删除的开始索引

    • endIndex: number

      要删除的结束索引（不含）

    Returns object

    返回替换记录

replace

  • replace(startIndex: number, endIndex: number, content: string | object | function): object

  • 替换文档中指定区间的内容

    Parameters

    • startIndex: number

      要替换的开始索引

    • endIndex: number

      要替换的结束索引（不含）

    • content: string | object | function

      要替换的新内容，如果是函数则为最后根据生成目标自动计算的内容

    Returns object

    返回替换记录

toString

  • toString(...args: any[]): string

  • 生成最终文本内容

    Parameters

    • Rest ...args: any[]

      传递给计算内容的函数参数

    Returns string

write

  • 将当前文档的内容写入到目标写入器

    Parameters

    • writer: TextWriter

      目标写入器

    • Rest ...args: any[]

      传递给计算内容的函数参数

    Returns void

Generated using TypeDoc