Interface SignatureHelpContext

Additional information about the context in which a signature help request was triggered.

3.15.0

interface SignatureHelpContext {
    activeSignatureHelp?: SignatureHelp;
    isRetrigger: boolean;
    triggerCharacter?: string;
    triggerKind: SignatureHelpTriggerKind;
}

Properties

activeSignatureHelp?: SignatureHelp

The currently active SignatureHelp.

The activeSignatureHelp has its SignatureHelp.activeSignature field updated based on the user navigating through available signatures.

isRetrigger: boolean

true if signature help was already showing when it was triggered.

Retriggers occurs when the signature help is already active and can be caused by actions such as typing a trigger character, a cursor move, or document content changes.

triggerCharacter?: string

Character that caused signature help to be triggered.

This is undefined when triggerKind !== SignatureHelpTriggerKind.TriggerCharacter

Action that caused signature help to be triggered.