Options
All
  • Public
  • Public/Protected
  • All
Menu

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.

Hierarchy

  • SignatureInformation

Index

Properties

Optional activeParameter

activeParameter: number

Index of the active parameter.

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

Optional documentation

documentation: string | IMarkdownString

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.

parameters

parameters: ParameterInformation[]

The parameters of this signature.

Generated using TypeDoc