languages

Interface SignatureInformation

Expand description

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?: number;
    documentation?: string | IMarkdownString;
    label: string;
    parameters: ParameterInformation[];
}

Properties§

§activeParameter?: number

Index of the active parameter.

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

§documentation?: string | IMarkdownString

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

§label: string

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

§parameters: ParameterInformation[]

The parameters of this signature.