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: ITextModel,
        position: Position,
        token: CancellationToken,
        context: SignatureHelpContext,
    ): 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: ITextModel,
    position: Position,
    token: CancellationToken,
    context: SignatureHelpContext,
): 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 src/components/monaco/bin/monaco.d.ts:7805