The document formatting provider interface defines the contract between extensions and the formatting-feature.
Fields
provideOnTypeFormattingEdits(document:TextDocument, position:Position, ch:String, options:FormattingOptions, token:CancellationToken):ProviderResult<Array<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 | The document in which the command was invoked. |
|---|---|
position | The position at which the command was invoked. |
ch | The character that has been typed. |
options | Options controlling formatting. |
token | A cancellation token. |
Returns:
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.