VS Code API
    Preparing search index...

    Class ParameterInformation

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

    Index

    Constructors

    Properties

    Constructors

    • 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

    Properties

    documentation?: string | MarkdownString

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

    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.