Options
All
  • Public
  • Public/Protected
  • All
Menu

Class 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

索引

Constructors

constructor

Properties

label

label: string

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

Optional documentation

documentation: string | MarkdownString

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

parameters

parameters: ParameterInformation[]

The parameters of this signature.

Optional activeParameter

activeParameter: number

The index of the active parameter.

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

Generated by TypeDoc