Interface CodeActionProviderMetadata

Metadata about the type of code actions that a CodeActionProvider providers

interface CodeActionProviderMetadata {
    documentation?: readonly {
        command: Command;
        kind: CodeActionKind;
    }[];
    providedCodeActionKinds?: readonly CodeActionKind[];
}

Properties

documentation? providedCodeActionKinds?

Properties

Optional documentation

documentation?: readonly {
    command: Command;
    kind: CodeActionKind;
}[]

Documentation from the provider is shown in the code actions menu

At most one documentation entry will be shown per provider.

Optional Readonly providedCodeActionKinds

providedCodeActionKinds?: readonly CodeActionKind[]

CodeActionKinds that this provider may return.

The list of kinds may be generic, such as CodeActionKind.Refactor, or the provider may list our every specific kind they provide, such as CodeActionKind.Refactor.Extract.append('function)`

Settings

Member Visibility

Theme

On This Page

documentationprovidedCodeActionKinds