Interface TextEditChange

A change to capture text edits for existing resources.

interface TextEditChange {
    add(edit: TextEdit | AnnotatedTextEdit | SnippetTextEdit): void;
    all(): (TextEdit | AnnotatedTextEdit | SnippetTextEdit)[];
    clear(): void;
    delete(range: Range): void;
    delete(range: Range, annotation?: string | ChangeAnnotation): string;
    insert(position: Position, newText: string): void;
    insert(
        position: Position,
        newText: string,
        annotation: string | ChangeAnnotation,
    ): string;
    replace(range: Range, newText: string): void;
    replace(
        range: Range,
        newText: string,
        annotation?: string | ChangeAnnotation,
    ): string;
}

Methods

add all clear delete insert replace

Methods

add

  • add(edit: TextEdit | AnnotatedTextEdit | SnippetTextEdit): void

  • Adds a text edit.

    Parameters

    Returns void

    Since

    3.16.0 - support for annotated text edits. This is usually guarded using a client capability.

    Since

    3.18.0 - support for snippet text edits. This is usually guarded using a client capability.

all

  • all(): (TextEdit | AnnotatedTextEdit | SnippetTextEdit)[]

  • Gets all text edits for this change.

    Returns (TextEdit | AnnotatedTextEdit | SnippetTextEdit)[]

    An array of text edits.

    Since

    3.16.0 - support for annotated text edits. This is usually guarded using a client capability.

    Since

    3.18.0 - support for snippet text edits. This is usually guarded using a client capability.

clear

  • clear(): void

  • Clears the edits for this change.

    Returns void

delete

  • delete(range: Range): void

  • Delete the text at the given range.

    Parameters

    Returns void

  • delete(range: Range, annotation?: string | ChangeAnnotation): string

  • Parameters

    Returns string

insert

  • insert(position: Position, newText: string): void

  • Insert the given text at the given position.

    Parameters

    • position: Position

      A position.

    • newText: string

      A string.

    Returns void

  • insert(
        position: Position,
        newText: string,
        annotation: string | ChangeAnnotation,
    ): string

  • Parameters

    Returns string

replace

  • replace(range: Range, newText: string): void

  • Replace the given range with given text for the given resource.

    Parameters

    • range: Range

      A range.

    • newText: string

      A string.

    Returns void

  • replace(
        range: Range,
        newText: string,
        annotation?: string | ChangeAnnotation,
    ): string

  • Parameters

    Returns string

Settings

Member Visibility

On This Page

Methods