Interface DocumentFormattingEditProvider

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

interface DocumentFormattingEditProvider {
displayName?: string;
provideDocumentFormattingEdits(model, options, token): ProviderResult<TextEdit[]>;
}

Index

Properties

Methods

provideDocumentFormattingEdits

Properties

`Optional` `Readonly` displayName

displayName?: string

Methods

provideDocumentFormattingEdits

provideDocumentFormattingEdits(model, options, token): ProviderResult<TextEdit[]>
Provide formatting edits for a whole document.
Parameters
- model: ITextModel
- options: FormattingOptions
- token: CancellationToken
Returns ProviderResult<TextEdit[]>
- Defined in editor.api.d.ts:7687