Skip to main content

modules/languages/symbols

Enumerations​

SymbolKind​

Defined in: modules/languages/symbols.d.ts:9

Kinds of document symbols. Represents the structural classification of a code token. Aligns with Monaco Editor's and VS Code's internal language server specifications.

Enumeration Members​

Array​

Array: 17

Defined in: modules/languages/symbols.d.ts:27

Boolean​

Boolean: 16

Defined in: modules/languages/symbols.d.ts:26

Class​

Class: 4

Defined in: modules/languages/symbols.d.ts:14

Constant​

Constant: 13

Defined in: modules/languages/symbols.d.ts:23

Constructor​

Constructor: 8

Defined in: modules/languages/symbols.d.ts:18

Enum​

Enum: 9

Defined in: modules/languages/symbols.d.ts:19

EnumMember​

EnumMember: 21

Defined in: modules/languages/symbols.d.ts:31

Event​

Event: 23

Defined in: modules/languages/symbols.d.ts:33

Field​

Field: 7

Defined in: modules/languages/symbols.d.ts:17

File​

File: 0

Defined in: modules/languages/symbols.d.ts:10

Function​

Function: 11

Defined in: modules/languages/symbols.d.ts:21

Interface​

Interface: 10

Defined in: modules/languages/symbols.d.ts:20

Key​

Key: 19

Defined in: modules/languages/symbols.d.ts:29

Method​

Method: 5

Defined in: modules/languages/symbols.d.ts:15

Module​

Module: 1

Defined in: modules/languages/symbols.d.ts:11

Namespace​

Namespace: 2

Defined in: modules/languages/symbols.d.ts:12

Null​

Null: 20

Defined in: modules/languages/symbols.d.ts:30

Number​

Number: 15

Defined in: modules/languages/symbols.d.ts:25

Object​

Object: 18

Defined in: modules/languages/symbols.d.ts:28

Operator​

Operator: 24

Defined in: modules/languages/symbols.d.ts:34

Package​

Package: 3

Defined in: modules/languages/symbols.d.ts:13

Property​

Property: 6

Defined in: modules/languages/symbols.d.ts:16

String​

String: 14

Defined in: modules/languages/symbols.d.ts:24

Struct​

Struct: 22

Defined in: modules/languages/symbols.d.ts:32

TypeParameter​

TypeParameter: 25

Defined in: modules/languages/symbols.d.ts:35

Variable​

Variable: 12

Defined in: modules/languages/symbols.d.ts:22

Interfaces​

DocumentSymbol​

Defined in: modules/languages/symbols.d.ts:42

Represents programming constructs like variables, functions, methods, or classes within a document. This structural hierarchy directly populates features like the Outline View and Breadcrumb rails.

Properties​

children?​

optional children?: DocumentSymbol[]

Defined in: modules/languages/symbols.d.ts:53

Sub-symbols or nested children contained hierarchically within this node block.

detail?​

optional detail?: string

Defined in: modules/languages/symbols.d.ts:47

Additional contextual details for this symbol, such as a function signature or return type.

kind​

kind: SymbolKind

Defined in: modules/languages/symbols.d.ts:50

The structural taxonomy kind of this symbol (e.g., Class, Function, Interface).

name​

name: string

Defined in: modules/languages/symbols.d.ts:44

The name of this symbol, e.g., 'calculateTotal' or 'UserClass'.

SymbolProvider​

Defined in: modules/languages/symbols.d.ts:60

Structural interface blueprint that third-party extension engines must conform to in order to inject custom syntax extraction logic into the global processing pipeline.

Methods​

provideSymbols()​

provideSymbols(text, languageId, model): DocumentSymbol[] | Promise<DocumentSymbol[]>

Defined in: modules/languages/symbols.d.ts:69

Parses document content and returns a collection of validated code symbols.

Parameters​
text​

string

The complete raw string value content of the targeted active editor document.

languageId​

string

The programming language token scope string identifier (e.g., 'javascript', 'rust').

model​

any

Pointers referencing the active, native Monaco text model engine framework instance.

Returns​

DocumentSymbol[] | Promise<DocumentSymbol[]>

An array of structured document symbols, or a Promise resolving to one.

References​

ActivityBarItemOptions​

Re-exports ActivityBarItemOptions

app​

Re-exports app

authentication​

Re-exports authentication

BookmarkFolder​

Re-exports BookmarkFolder

CommandMetadata​

Re-exports CommandMetadata

commands​

Re-exports commands

CommitOptions​

Re-exports CommitOptions

ConfigurationProperty​

Re-exports ConfigurationProperty

CopyOptions​

Re-exports CopyOptions

Diagnostic​

Re-exports Diagnostic

DiagnosticCollection​

Re-exports DiagnosticCollection

DiagnosticSeverity​

Re-exports DiagnosticSeverity

Disposable​

Re-exports Disposable

ExtensionContext​

Re-exports ExtensionContext

ExtensionInfo​

Re-exports ExtensionInfo

extensions​

Re-exports extensions

FileDecoration​

Re-exports FileDecoration

FileFilter​

Re-exports FileFilter

FileStat​

Re-exports FileStat

FileSystemAPI​

Re-exports FileSystemAPI

FindOptions​

Re-exports FindOptions

fs​

Re-exports fs

git​

Re-exports git

GitBranch​

Re-exports GitBranch

GitChangedFile​

Re-exports GitChangedFile

GitCommit​

Re-exports GitCommit

GitFileStatus​

Re-exports GitFileStatus

GitHubUser​

Re-exports GitHubUser

GitRepository​

Re-exports GitRepository

GitSortMode​

Re-exports GitSortMode

GitStash​

Re-exports GitStash

IConfigurationSection​

Re-exports IConfigurationSection

IconThemeDefinition​

Re-exports IconThemeDefinition

IconThemeMap​

Re-exports IconThemeMap

InputBoxOptions​

Re-exports InputBoxOptions

languages​

Re-exports languages

lsp​

Re-exports lsp

LspServerConfig​

Re-exports LspServerConfig

Re-exports MenuItem

Re-exports menus

ModalOptions​

Re-exports ModalOptions

MSCodeUIColors​

Re-exports MSCodeUIColors

MultiPickerOptions​

Re-exports MultiPickerOptions

NotificationAction​

Re-exports NotificationAction

OutputChannel​

Re-exports OutputChannel

PickerOptions​

Re-exports PickerOptions

Position​

Re-exports Position

ProgressNotification​

Re-exports ProgressNotification

QuickPickItem​

Re-exports QuickPickItem

QuickPickOptions​

Re-exports QuickPickOptions

RecentWorkspace​

Re-exports RecentWorkspace

ReplaceOptions​

Re-exports ReplaceOptions

ResolvedIcon​

Re-exports ResolvedIcon

Re-exports search

SearchFileResult​

Re-exports SearchFileResult

SearchMatch​

Re-exports SearchMatch

Selection​

Re-exports Selection

SettingOption​

Re-exports SettingOption

SettingType​

Re-exports SettingType

SidebarPanelDef​

Re-exports SidebarPanelDef

SidebarPanelHeader​

Re-exports SidebarPanelHeader

SidebarSectionContent​

Re-exports SidebarSectionContent

SidebarSectionContext​

Re-exports SidebarSectionContext

SidebarSectionDef​

Re-exports SidebarSectionDef

SidebarState​

Re-exports SidebarState

SilentSearchOptions​

Re-exports SilentSearchOptions

StashOptions​

Re-exports StashOptions

StatusBarAlignment​

Re-exports StatusBarAlignment

StatusBarItemController​

Re-exports StatusBarItemController

StatusBarItemOptions​

Re-exports StatusBarItemOptions

Tab​

Re-exports Tab

TabDiffData​

Re-exports TabDiffData

TabOptions​

Re-exports TabOptions

TabType​

Re-exports TabType

TaskExecution​

Re-exports TaskExecution

TaskOptions​

Re-exports TaskOptions

tasks​

Re-exports tasks

Terminal​

Re-exports Terminal

TerminalExitStatus​

Re-exports TerminalExitStatus

TerminalOptions​

Re-exports TerminalOptions

termis​

Re-exports termis

TermisView​

Re-exports TermisView

TextDocument​

Re-exports TextDocument

TextEditor​

Re-exports TextEditor

TextEditorEdit​

Re-exports TextEditorEdit

TextEditorOptions​

Re-exports TextEditorOptions

ThemeDefinition​

Re-exports ThemeDefinition

themes​

Re-exports themes

TokenColor​

Re-exports TokenColor

TreeDataProvider​

Re-exports TreeDataProvider

TreeItem​

Re-exports TreeItem

TreeView​

Re-exports TreeView

TreeViewOptions​

Re-exports TreeViewOptions

window​

Re-exports window

workspace​

Re-exports workspace

WorkspaceConfiguration​

Re-exports WorkspaceConfiguration

WorkspaceFolder​

Re-exports WorkspaceFolder

WriteOptions​

Re-exports WriteOptions