Class ParameterInformation

Represents a parameter of a callable-signature. A parameter can have a label and a doc-comment.

Index

Constructors

Properties

documentation? label

Constructors

constructor

new ParameterInformation(
label: string | [number, number],
documentation?: string | MarkdownString,
): ParameterInformation
Creates a new parameter information object.
Parameters
- label: string | [number, number]
  A label string or inclusive start and exclusive end offsets within its containing signature label.
- Optionaldocumentation: string | MarkdownString
  A doc string.
Returns ParameterInformation
- Defined in packages/plugin/src/theia.d.ts:8885

Properties

`Optional`documentation

documentation?: string | MarkdownString

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

label

label: string | [number, number]

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