Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DocumentRangeFormattingEditProvider

The document formatting provider interface defines the contract between extensions and the formatting-feature.

Hierarchy

  • DocumentRangeFormattingEditProvider

Index

Methods(1)

provideDocumentRangeFormattingEdits

  • Provide formatting edits for a range in a document.

    The given range is a hint and providers can decide to format a smaller or larger range. Often this is done by adjusting the start and end of the range to full syntax nodes.

    Parameters

    Returns ProviderResult<TextEdit[]>

    A set of text edits or a thenable that resolves to such. The lack of a result can be signaled by returning undefined, null, or an empty array.

Generated by TypeDoc. Maintained by 洛竹