Interface OnTypeFormattingEditProvider

provideOnTypeFormattingEdits

• provideOnTypeFormattingEdits(
      document: TextDocument,
      position: Position,
      ch: string,
      options: FormattingOptions,
      token: undefined | CancellationToken,
  ): ProviderResult<undefined | TextEdit[]>

  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: undefined | CancellationToken

    A cancellation token.

  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.