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

    Interface OnTypeFormattingEditProvider

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

    interface OnTypeFormattingEditProvider {
        provideOnTypeFormattingEdits(
            document: TextDocument,
            position: Position,
            ch: string,
            options: FormattingOptions,
            token: CancellationToken | undefined,
        ): ProviderResult<TextEdit[] | undefined>;
    }
    Index
    • Provide formatting edits after a character has been typed.

      The given position and character should hint to the provider what range the position to expand to, like find the matching { when } has been entered.

      Parameters

      • document: TextDocument

        The document in which the command was invoked.

      • position: Position

        The position at which the command was invoked.

      • ch: string

        The character that has been typed.

      • options: FormattingOptions

        Options controlling formatting.

      • token: CancellationToken | undefined

        A cancellation token.

      Returns ProviderResult<TextEdit[] | undefined>

      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.