Interface SignatureInformation

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

interface SignatureInformation {
    activeParameter?: null | number;
    documentation?: string | MarkupContent;
    label: string;
    parameters?: ParameterInformation[];
}

Properties

activeParameter? documentation? label parameters?

Properties

OptionalactiveParameter

activeParameter?: null | number

The index of the active parameter.

If null, no parameter of the signature is active (for example a named argument that does not match any declared parameters). This is only valid if the client specifies the client capability textDocument.signatureHelp.noActiveParameterSupport === true

If provided (or null), this is used in place of SignatureHelp.activeParameter.

Since

3.16.0

Optionaldocumentation

documentation?: string | MarkupContent

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

label

label: string

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

Optionalparameters

parameters?: ParameterInformation[]

The parameters of this signature.

Settings

Member Visibility

On This Page

Properties