Interface SignatureHelpProvider

The signature help provider interface defines the contract between extensions and the parameter hints-feature.

interface SignatureHelpProvider {
    signatureHelpRetriggerCharacters?: readonly string[];
    signatureHelpTriggerCharacters?: readonly string[];
    provideSignatureHelp(model, position, token, context): ProviderResult<SignatureHelpResult>;
}

Index

Properties

signatureHelpRetriggerCharacters? signatureHelpTriggerCharacters?

Methods

provideSignatureHelp

Properties

`Optional` `Readonly` signatureHelpRetriggerCharacters

signatureHelpRetriggerCharacters?: readonly string[]

`Optional` `Readonly` signatureHelpTriggerCharacters

signatureHelpTriggerCharacters?: readonly string[]

Methods

provideSignatureHelp

provideSignatureHelp(model, position, token, context): ProviderResult<SignatureHelpResult>
Provide help for the signature at the given position and document.
Parameters
- model: ITextModel
- position: Position
- token: CancellationToken
- context: SignatureHelpContext
Returns ProviderResult<SignatureHelpResult>
- Defined in editor.api.d.ts:7383