Interface CompletionItemLabel

A structured label for a completion item.

interface CompletionItemLabel {
    description?: string;
    detail?: string;
    label: string;
}

Properties

description? detail? label

Properties

Optional description

description?: string

An optional string which is rendered less prominently after CompletionItemLabel.detail. Should be used for fully qualified names or file path.

Optional detail

detail?: string

An optional string which is rendered less prominently directly after label, without any spacing. Should be used for function signatures or type annotations.

label

label: string

The label of this completion item.

By default this is also the text that is inserted when this completion is selected.

Settings

Member Visibility

Theme

On This Page

descriptiondetaillabel