Theia API Documentation v1.65.0
    Preparing search index...

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

    interface DocumentRangeFormattingEditProvider {
        provideDocumentRangeFormattingEdits(
            document: TextDocument,
            range: Range,
            options: FormattingOptions,
            token: undefined | CancellationToken,
        ): ProviderResult<undefined | TextEdit[]>;
        provideDocumentRangesFormattingEdits?(
            document: TextDocument,
            ranges: Range[],
            options: FormattingOptions,
            token: CancellationToken,
        ): ProviderResult<TextEdit[]>;
    }
    Index

    Methods

    • 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<undefined | 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.

    • Provide formatting edits for multiple ranges in a document.

      This function is optional but allows a formatter to perform faster when formatting only modified ranges or when formatting a large number of selections.

      The given ranges are hints 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.

      the current monaco version does not yet use this API