Interface WorkspaceSymbol

A special workspace symbol that supports locations without a range.

See also SymbolInformation.

3.17.0

interface WorkspaceSymbol {
    containerName?: string;
    data?: any;
    kind: SymbolKind;
    location: Location | LocationUriOnly;
    name: string;
    tags?: 1[];
}

Hierarchy (View Summary)

Properties

containerName?: string

The name of the symbol containing this symbol. This information is for user interface purposes (e.g. to render a qualifier in the user interface if necessary). It can't be used to re-infer a hierarchy for the document symbols.

data?: any

A data entry field that is preserved on a workspace symbol between a workspace symbol request and a workspace symbol resolve request.

The kind of this symbol.

The location of the symbol. Whether a server is allowed to return a location without a range depends on the client capability workspace.symbol.resolveSupport.

See SymbolInformation#location for more details.

name: string

The name of this symbol.

tags?: 1[]

Tags for this symbol.

3.16.0