View source

typedef SignatureHelpContext

package languageServerProtocol.protocol

import languageServerProtocol.protocol.Protocol

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

Available since

3.15.0

.

Fields

triggerKind:SignatureHelpTriggerKind

Action that caused signature help to be triggered.

@:optionaloptionaltriggerCharacter:Null<String>

Character that caused signature help to be triggered.

This is undefined when triggerKind !== SignatureHelpTriggerKind.TriggerCharacter

isRetrigger:Bool

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

Retriggers occur 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.

@:optionaloptionalactiveSignatureHelp:Null<SignatureHelp>

The currently active SignatureHelp.

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