Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ParameterInformation

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

Hierarchy

  • ParameterInformation

Index

Constructors(1)

Properties(2)

Constructors(1)

constructor

  • 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.

    • Optional documentation: string | MarkdownString

      A doc string.

    Returns ParameterInformation

Properties(2)

label

label: string | [number, number]

The label of this signature.

Either a string or inclusive start and exclusive end offsets within its containing signature label. Note: A label of type string must be a substring of its containing signature information's label.

Optional documentation

documentation: string | MarkdownString

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

Generated by TypeDoc. Maintained by 洛竹