View source

typedef SignatureInformation

package languageServerProtocol

import languageServerProtocol.Types

Represents the signature of something callable. A signature can have a label, like a function-name, a doc-comment, and a set of parameters.

Fields

@:optionaloptionalparameters:Null<Array<ParameterInformation>>

The parameters of this signature.

label:String

The label of this signature. Will be shown in the UI.

@:optionaloptionaldocumentation:Null<EitherType<String, MarkupContent>>

The human-readable doc-comment of this signature. Will be shown in the UI but can be omitted.

@:optionaloptionalactiveParameter:Null<Int>

The index of the active parameter.

If provided, this is used in place of SignatureHelp.activeParameter.

Available since

3.16.0

.