View source

typedef WorkspaceSymbol

package languageServerProtocol

import languageServerProtocol.Types

A special workspace symbol that supports locations without a range.

See also SymbolInformation.

Available since

3.17.0

.

Fields

@:optionaloptionaltags:Null<Array<SymbolTag>>

Tags for this completion item.

Available since

3.16.0

.

name:String

The name of this symbol.

location:EitherType<Location, {uri:DocumentUri}>

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.

kind:SymbolKind

The kind of this symbol.

@:optionaloptionaldata:Null<LSPAny>

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

@:optionaloptionalcontainerName:Null<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.