Options
All
  • Public
  • Public/Protected
  • All
Menu

Module core

Index

References

Namespaces

Enumerations

Classes

Interfaces

Type Aliases

Variables

Functions

References

Re-exports ACCOUNTS_MENU
Re-exports ACCOUNTS_MENU
Re-exports ACCOUNTS_SUBMENU
Re-exports ACCOUNTS_SUBMENU
Re-exports ACTION_ITEM
Re-exports ACTION_ITEM
Re-exports AbstractChannel
Re-exports AbstractChannel
Re-exports AbstractDialog
Re-exports AbstractReferenceCollection
Re-exports AbstractTreeDecoratorService
Re-exports AbstractTreeDecoratorService
Re-exports AbstractTreeIterator
Re-exports AbstractTreeIterator
Re-exports AbstractViewContribution
Re-exports AbstractViewContribution
Re-exports ActionMenuNode
Re-exports ActionMenuNode
Re-exports AlternativeHandlerMenuNode
Re-exports AlternativeHandlerMenuNode
Re-exports Anchor
Re-exports AnyToolbarItem
Re-exports ApplicationError
Re-exports ApplicationShell
Re-exports ApplicationShell
Re-exports ApplicationShellLayoutMigration
Re-exports ApplicationShellLayoutMigration
Re-exports ApplicationShellLayoutMigrationContext
Re-exports ApplicationShellLayoutMigrationContext
Re-exports ApplicationShellLayoutMigrationError
Re-exports ApplicationShellLayoutMigrationError
Re-exports ApplicationShellLayoutVersion
Re-exports ApplicationShellLayoutVersion
Re-exports ApplicationShellOptions
Re-exports ApplicationShellOptions
Re-exports ArrayUtils
Re-exports ArrayUtils
Re-exports AsyncEmitter
Re-exports BUSY_CLASS
Re-exports BUSY_CLASS
Re-exports BackendApplication
Re-exports BackendApplicationCliContribution
Re-exports BackendApplicationContribution
Re-exports BackendApplicationServer
Re-exports BackendStopwatch
Re-exports BackendStopwatch
Re-exports BackendStopwatchOptions
Re-exports BackendStopwatchOptions
Re-exports BadgeWidget
Re-exports BaseWidget
Re-exports BaseWidget
Re-exports Bindable
Re-exports BottomUpTreeIterator
Re-exports BottomUpTreeIterator
Re-exports Breadcrumb
Re-exports Breadcrumb
Re-exports BreadcrumbID
Re-exports BreadcrumbID
Re-exports BreadcrumbPopupContainer
Re-exports BreadcrumbPopupContainer
Re-exports BreadcrumbPopupContainerFactory
Re-exports BreadcrumbPopupContainerFactory
Re-exports BreadcrumbRenderer
Re-exports BreadcrumbRenderer
Re-exports BreadcrumbsContribution
Re-exports BreadcrumbsContribution
Re-exports BreadcrumbsRenderer
Re-exports BreadcrumbsRenderer
Re-exports BreadcrumbsRendererFactory
Re-exports BreadcrumbsRendererFactory
Re-exports BreadcrumbsService
Re-exports BreadcrumbsService
Re-exports BreadthFirstTreeIterator
Re-exports BreadthFirstTreeIterator
Re-exports BrowserKeyboardFrontendContribution
Re-exports BrowserKeyboardFrontendContribution
Re-exports BrowserKeyboardLayoutProvider
Re-exports BrowserKeyboardLayoutProvider
Re-exports CLEAR_COMMAND_HISTORY
Re-exports CLEAR_COMMAND_HISTORY
Re-exports CLOSE_QUICK_OPEN
Re-exports CLOSE_QUICK_OPEN
Re-exports CMD
Re-exports CODICON_LOADING_CLASSES
Re-exports CODICON_LOADING_CLASSES
Re-exports CODICON_TREE_ITEM_CLASSES
Re-exports CODICON_TREE_ITEM_CLASSES
Re-exports COLLAPSED_CLASS
Re-exports COLLAPSED_CLASS
Re-exports COMPOSITE_TREE_NODE_CLASS
Re-exports COMPOSITE_TREE_NODE_CLASS
Re-exports CSSIcon
Re-exports CancellationError
Re-exports CancellationToken
Re-exports CancellationTokenSource
Re-exports Channel
Re-exports Channel
Re-exports ChannelCloseEvent
Re-exports ChannelCloseEvent
Re-exports CliContribution
Re-exports CliManager
Re-exports ColorTheme
Re-exports Command
Re-exports CommandContribution
Re-exports CommandEvent
Re-exports CommandHandler
Re-exports CommandMenuNode
Re-exports CommandMenuNode
Re-exports CommandRegistry
Re-exports CommandService
Re-exports CommonCommands
Re-exports CommonFrontendContribution
Re-exports CommonMenus
Re-exports CompositeMenuNode
Re-exports CompositeMenuNode
Re-exports CompositeMenuNodeWrapper
Re-exports CompositeMenuNodeWrapper
Re-exports CompositeTreeElement
Re-exports CompositeTreeElementNode
Re-exports CompositeTreeNode
Re-exports CompositeTreeNode
Re-exports CompoundMenuNode
Re-exports CompoundMenuNode
Re-exports CompoundMenuNodeRole
Re-exports CompoundMenuNodeRole
Re-exports CompressedChildren
Re-exports CompressedChildren
Re-exports CompressedChildren
Re-exports CompressedExpansionService
Re-exports CompressedExpansionService
Re-exports CompressedExpansionService
Re-exports CompressedNodeProps
Re-exports CompressedNodeProps
Re-exports CompressedNodeProps
Re-exports CompressedNodeRow
Re-exports CompressedNodeRow
Re-exports CompressedNodeRow
Re-exports CompressedTreeModel
Re-exports CompressedTreeModel
Re-exports CompressedTreeModel
Re-exports CompressedTreeWidget
Re-exports CompressedTreeWidget
Re-exports CompressedTreeWidget
Re-exports CompressionChild
Re-exports CompressionChild
Re-exports CompressionChild
Re-exports CompressionHead
Re-exports CompressionHead
Re-exports CompressionHead
Re-exports CompressionParent
Re-exports CompressionParent
Re-exports CompressionParent
Re-exports CompressionParticipant
Re-exports CompressionParticipant
Re-exports CompressionParticipant
Re-exports CompressionTail
Re-exports CompressionTail
Re-exports CompressionTail
Re-exports CompressionToggle
Re-exports CompressionToggle
Re-exports CompressionToggle
Re-exports ConfirmDialog
Re-exports ConfirmDialogProps
Re-exports ConfirmSaveDialog
Re-exports ConfirmSaveDialogProps
Re-exports ConnectionErrorHandler
Re-exports ConnectionErrorHandler
Re-exports ConnectionErrorHandlerOptions
Re-exports ConnectionErrorHandlerOptions
Re-exports ConnectionHandler
Re-exports ConnectionHandler
Re-exports ContextMenuAccess
Re-exports ContextMenuRenderer
Re-exports ContributionFilterRegistry
Re-exports ContributionFilterRegistry
Re-exports ContributionFilterRegistryImpl
Re-exports ContributionFilterRegistryImpl
Re-exports ContributionProvider
Re-exports ContributionType
Re-exports ContributionType
Re-exports Coordinate
Re-exports CoreConfiguration
Re-exports CorePreferenceContribution
Re-exports CorePreferences
Re-exports CssStyleCollector
Re-exports DEBUG_MODE
Re-exports DEFAULT_LAYOUT_DATA
Re-exports DEFAULT_LAYOUT_DATA
Re-exports DEFAULT_SCROLL_OPTIONS
Re-exports DEFAULT_SCROLL_OPTIONS
Re-exports DISABLED_CLASS
Re-exports DISABLED_CLASS
Re-exports DecoratedTreeNode
Re-exports DecoratedTreeNode
Re-exports DecorationStyle
Re-exports DefaultBackendStopwatch
Re-exports DefaultBackendStopwatch
Re-exports DefaultBreadcrumbRenderer
Re-exports DefaultBreadcrumbRenderer
Re-exports DefaultFrontendApplicationContribution
Re-exports DefaultOpenerService
Re-exports DefaultResourceProvider
Re-exports DefaultUriLabelProviderContribution
Re-exports Deferred
Re-exports DepthFirstTreeIterator
Re-exports DepthFirstTreeIterator
Re-exports DescriptionWidget
Re-exports Dialog
Re-exports DialogError
Re-exports DialogMode
Re-exports DialogOverlayService
Re-exports DialogProps
Re-exports DidChangeLabelEvent
Re-exports DidCreateWidgetEvent
Re-exports DiffUriLabelProviderContribution
Re-exports DiffUris
Re-exports Disposable
Re-exports DisposableCollection
Re-exports DisposableGroup
Re-exports DockPanelRenderer
Re-exports DockPanelRenderer
Re-exports DockPanelRendererFactory
Re-exports DockPanelRendererFactory
Re-exports DynamicToolbarWidget
Re-exports EXPANDABLE_TREE_NODE_CLASS
Re-exports EXPANDABLE_TREE_NODE_CLASS
Re-exports EXPANSION_TOGGLE_CLASS
Re-exports EXPANSION_TOGGLE_CLASS
Re-exports ElectronMainApplicationGlobals
Re-exports Emitter
Re-exports EmitterOptions
Re-exports Endpoint
Re-exports EnvVariable
Re-exports EnvVariablesServer
Re-exports EnvVariablesServerImpl
Re-exports Event
Re-exports EventListener
Re-exports EventListener
Re-exports EventListenerObject
Re-exports EventListenerObject
Re-exports EventListenerOrEventListenerObject
Re-exports EventListenerOrEventListenerObject
Re-exports ExpandableTreeNode
Re-exports ExpandableTreeNode
Re-exports ExtractableWidget
Re-exports ExtractableWidget
Re-exports FOCUS_CLASS
Re-exports FOCUS_CLASS
Re-exports FileSystemLocking
Re-exports FileUri
Re-exports Filter
Re-exports Filter
Re-exports FilterContribution
Re-exports FilterContribution
Re-exports FormatType
Re-exports FrontendApplication
Re-exports FrontendApplicationContribution
Re-exports FrontendApplicationPreferenceConfig
Re-exports FrontendApplicationPreferenceConfig
Re-exports FrontendApplicationState
Re-exports FrontendStopwatch
Re-exports HoverPosition
Re-exports HoverRequest
Re-exports HoverService
Re-exports ILogger
Re-exports IPCChannel
Re-exports IPCChannel
Re-exports IPCConnectionOptions
Re-exports IPCConnectionOptions
Re-exports IPCConnectionProvider
Re-exports IPCConnectionProvider
Re-exports InMemoryResources
Re-exports InMemoryTextResource
Re-exports InMemoryTextResourceResolver
Re-exports InputBox
Re-exports InputBox
Re-exports InputBox
Re-exports InputBox
Re-exports InputOptions
Re-exports InputOptions
Re-exports InputOptions
Re-exports InputOptions
Re-exports Iterators
Re-exports Iterators
Re-exports JsonRpcConnectionEventEmitter
Re-exports JsonRpcConnectionEventEmitter
Re-exports JsonRpcConnectionHandler
Re-exports JsonRpcConnectionHandler
Re-exports JsonRpcProxy
Re-exports JsonRpcProxy
Re-exports JsonRpcProxyFactory
Re-exports JsonRpcProxyFactory
Re-exports JsonRpcServer
Re-exports JsonRpcServer
Re-exports Key
Re-exports Key
Re-exports Key
Re-exports Key
Re-exports KeyCode
Re-exports KeyCode
Re-exports KeyCode
Re-exports KeyCode
Re-exports KeyCodeSchema
Re-exports KeyCodeSchema
Re-exports KeyCodeSchema
Re-exports KeyModifier
Re-exports KeyModifier
Re-exports KeyModifier
Re-exports KeyModifier
Re-exports KeySequence
Re-exports KeySequence
Re-exports KeySequence
Re-exports KeySequence
Re-exports Keybinding
Re-exports KeybindingContext
Re-exports KeybindingContexts
Re-exports KeybindingContribution
Re-exports KeybindingRegistry
Re-exports KeybindingScope
Re-exports KeyboardCommands
Re-exports KeyboardCommands
Re-exports KeyboardLayout
Re-exports KeyboardLayout
Re-exports KeyboardLayoutData
Re-exports KeyboardLayoutData
Re-exports KeyboardLayoutService
Re-exports KeyboardLayoutService
Re-exports KeyboardLayoutSource
Re-exports KeyboardLayoutSource
Re-exports KeyboardTester
Re-exports KeyboardTester
Re-exports KeyboardTesterState
Re-exports KeyboardTesterState
Re-exports KeysOrKeyCodes
Re-exports KeysOrKeyCodes
Re-exports KeysOrKeyCodes
Re-exports KeysOrKeyCodes
Re-exports Keystroke
Re-exports Keystroke
Re-exports Keystroke
Re-exports Keystroke
Re-exports LEFT_RIGHT_AREA_CLASS
Re-exports LEFT_RIGHT_AREA_CLASS
Re-exports LOCKED_CLASS
Re-exports LOCKED_CLASS
Re-exports LabelProvider
Re-exports LabelProviderContribution
Re-exports LayoutProviderState
Re-exports LayoutProviderState
Re-exports LocalStorageService
Re-exports Log
Re-exports LogLevel
Re-exports LogLevel
Re-exports Loggable
Re-exports Logger
Re-exports LoggerFactory
Re-exports LoggerName
Re-exports MAIN_MENU_BAR
Re-exports MAIN_MENU_BAR
Re-exports MAX_SAFE_INTEGER
Re-exports MEMORY_TEXT
Re-exports MarkdownString
Re-exports MarkdownStringImpl
Re-exports MarkdownStringTextNewlineStyle
Re-exports Match
Re-exports Match
Re-exports Match
Re-exports Match
Re-exports MaybeArray
Re-exports MaybeNull
Re-exports MaybePromise
Re-exports MaybeUndefined
Re-exports Measurement
Re-exports Measurement
Re-exports MeasurementOptions
Re-exports MeasurementOptions
Re-exports MenuAction
Re-exports MenuAction
Re-exports MenuCommandAdapter
Re-exports MenuCommandAdapter
Re-exports MenuCommandAdapterRegistry
Re-exports MenuCommandAdapterRegistry
Re-exports MenuCommandAdapterRegistryImpl
Re-exports MenuCommandAdapterRegistryImpl
Re-exports MenuCommandArguments
Re-exports MenuCommandArguments
Re-exports MenuCommandExecutor
Re-exports MenuCommandExecutor
Re-exports MenuCommandExecutorImpl
Re-exports MenuCommandExecutorImpl
Re-exports MenuContribution
Re-exports MenuContribution
Re-exports MenuDelegate
Re-exports MenuModelRegistry
Re-exports MenuModelRegistry
Re-exports MenuNode
Re-exports MenuNode
Re-exports MenuNodeBase
Re-exports MenuNodeBase
Re-exports MenuNodeMetadata
Re-exports MenuNodeMetadata
Re-exports MenuNodeRenderingData
Re-exports MenuNodeRenderingData
Re-exports MenuPath
Re-exports MenuPath
Re-exports MenuToolbarItem
Re-exports Message
Re-exports MessageClient
Re-exports MessageDialogProps
Re-exports MessageOptions
Re-exports MessageProvider
Re-exports MessageProvider
Re-exports MessageService
Re-exports MessageType
Re-exports MessagingService
Re-exports MessagingService
Re-exports MockPreferenceProvider
Re-exports MockPreferenceService
Re-exports MoveEntry
Re-exports MoveEntry
Re-exports Mutable
Re-exports MutableCompoundMenuNode
Re-exports MutableCompoundMenuNode
Re-exports MutableResource
Re-exports NAVIGATION
Re-exports Navigatable
Re-exports Navigatable
Re-exports NavigatableWidget
Re-exports NavigatableWidget
Re-exports NavigatableWidgetOpenHandler
Re-exports NavigatableWidgetOptions
Re-exports NavigatableWidgetOptions
Re-exports NodeProps
Re-exports NodeProps
Re-exports NodeStopwatch
Re-exports NoopTreeDecoratorService
Re-exports NoopTreeDecoratorService
Re-exports NormalizedQuickInputButton
Re-exports NormalizedQuickInputButton
Re-exports NormalizedQuickInputButton
Re-exports NormalizedQuickInputButton
Re-exports NullBackendStopwatch
Re-exports NullBackendStopwatch
Re-exports OS
Re-exports OVERRIDE_PROPERTY_PATTERN
Re-exports OVERRIDE_PROPERTY_PATTERN
Re-exports OnWillStopAction
Re-exports OpenHandler
Re-exports OpenViewArguments
Re-exports OpenViewArguments
Re-exports OpenerOptions
Re-exports OpenerService
Re-exports OverridePreferenceName
Re-exports OverridePreferenceName
Re-exports PINNED_CLASS
Re-exports PINNED_CLASS
Re-exports PartialCSSStyle
Re-exports Path
Re-exports PickOptions
Re-exports PickOptions
Re-exports PickOptions
Re-exports PickOptions
Re-exports PostCreationSaveableWidget
Re-exports PreferenceChange
Re-exports PreferenceChange
Re-exports PreferenceChangeEvent
Re-exports PreferenceChangeEvent
Re-exports PreferenceChangeImpl
Re-exports PreferenceChangeImpl
Re-exports PreferenceChanges
Re-exports PreferenceChanges
Re-exports PreferenceContribution
Re-exports PreferenceContribution
Re-exports PreferenceDataProperty
Re-exports PreferenceDataProperty
Re-exports PreferenceDataProperty
Re-exports PreferenceDataSchema
Re-exports PreferenceDataSchema
Re-exports PreferenceDataSchema
Re-exports PreferenceEventEmitter
Re-exports PreferenceEventEmitter
Re-exports PreferenceInspection
Re-exports PreferenceInspection
Re-exports PreferenceInspectionScope
Re-exports PreferenceInspectionScope
Re-exports PreferenceItem
Re-exports PreferenceItem
Re-exports PreferenceItem
Re-exports PreferenceLanguageOverrideService
Re-exports PreferenceLanguageOverrideService
Re-exports PreferenceProvider
Re-exports PreferenceProvider
Re-exports PreferenceProviderDataChange
Re-exports PreferenceProviderDataChange
Re-exports PreferenceProviderDataChanges
Re-exports PreferenceProviderDataChanges
Re-exports PreferenceProviderProvider
Re-exports PreferenceProviderProvider
Re-exports PreferenceProxy
Re-exports PreferenceProxy
Re-exports PreferenceProxyOptions
Re-exports PreferenceProxyOptions
Re-exports PreferenceResolveResult
Re-exports PreferenceResolveResult
Re-exports PreferenceRetrieval
Re-exports PreferenceRetrieval
Re-exports PreferenceSchema
Re-exports PreferenceSchema
Re-exports PreferenceSchema
Re-exports PreferenceSchemaProperties
Re-exports PreferenceSchemaProperties
Re-exports PreferenceSchemaProperties
Re-exports PreferenceSchemaProperty
Re-exports PreferenceSchemaProperty
Re-exports PreferenceSchemaProperty
Re-exports PreferenceSchemaProvider
Re-exports PreferenceSchemaProvider
Re-exports PreferenceScope
Re-exports PreferenceScope
Re-exports PreferenceScope
Re-exports PreferenceScope
Re-exports PreferenceService
Re-exports PreferenceService
Re-exports PreferenceServiceImpl
Re-exports PreferenceServiceImpl
Re-exports PreferenceValidationResult
Re-exports PreferenceValidationResult
Re-exports PreferenceValidationService
Re-exports PreferenceValidationService
Re-exports PreferenceValidator
Re-exports PreferenceValidator
Re-exports Prioritizeable
Re-exports Prioritizeable
Re-exports Progress
Re-exports ProgressClient
Re-exports ProgressMessage
Re-exports ProgressMessageOptions
Re-exports ProgressService
Re-exports ProgressUpdate
Re-exports QuickAccessContribution
Re-exports QuickAccessContribution
Re-exports QuickAccessProvider
Re-exports QuickAccessProvider
Re-exports QuickAccessProviderDescriptor
Re-exports QuickAccessProviderDescriptor
Re-exports QuickAccessProviderHelp
Re-exports QuickAccessProviderHelp
Re-exports QuickAccessRegistry
Re-exports QuickAccessRegistry
Re-exports QuickCommandFrontendContribution
Re-exports QuickCommandFrontendContribution
Re-exports QuickCommandService
Re-exports QuickCommandService
Re-exports QuickHelpService
Re-exports QuickHelpService
Re-exports QuickInput
Re-exports QuickInput
Re-exports QuickInput
Re-exports QuickInput
Re-exports QuickInputButton
Re-exports QuickInputButton
Re-exports QuickInputButton
Re-exports QuickInputButton
Re-exports QuickInputButtonHandle
Re-exports QuickInputButtonHandle
Re-exports QuickInputButtonHandle
Re-exports QuickInputButtonHandle
Re-exports QuickInputFrontendContribution
Re-exports QuickInputFrontendContribution
Re-exports QuickInputHideReason
Re-exports QuickInputHideReason
Re-exports QuickInputHideReason
Re-exports QuickInputHideReason
Re-exports QuickInputService
Re-exports QuickInputService
Re-exports QuickInputService
Re-exports QuickInputService
Re-exports QuickPick
Re-exports QuickPick
Re-exports QuickPick
Re-exports QuickPick
Re-exports QuickPickInput
Re-exports QuickPickInput
Re-exports QuickPickInput
Re-exports QuickPickInput
Re-exports QuickPickItem
Re-exports QuickPickItem
Re-exports QuickPickItem
Re-exports QuickPickItem
Re-exports QuickPickItemButtonContext
Re-exports QuickPickItemButtonContext
Re-exports QuickPickItemButtonContext
Re-exports QuickPickItemButtonContext
Re-exports QuickPickItemButtonEvent
Re-exports QuickPickItemButtonEvent
Re-exports QuickPickItemButtonEvent
Re-exports QuickPickItemButtonEvent
Re-exports QuickPickItemHighlights
Re-exports QuickPickItemHighlights
Re-exports QuickPickItemHighlights
Re-exports QuickPickItemHighlights
Re-exports QuickPickItemOrSeparator
Re-exports QuickPickItemOrSeparator
Re-exports QuickPickItemOrSeparator
Re-exports QuickPickItemOrSeparator
Re-exports QuickPickOptions
Re-exports QuickPickOptions
Re-exports QuickPickOptions
Re-exports QuickPickOptions
Re-exports QuickPickSeparator
Re-exports QuickPickSeparator
Re-exports QuickPickSeparator
Re-exports QuickPickSeparator
Re-exports QuickPickService
Re-exports QuickPickService
Re-exports QuickPickService
Re-exports QuickPickService
Re-exports QuickPickServiceImpl
Re-exports QuickPickServiceImpl
Re-exports QuickPickValue
Re-exports QuickPickValue
Re-exports QuickPickValue
Re-exports QuickPickValue
Re-exports QuickPicks
Re-exports QuickPicks
Re-exports QuickPicks
Re-exports QuickPicks
Re-exports QuickViewItem
Re-exports QuickViewItem
Re-exports QuickViewService
Re-exports QuickViewService
Re-exports RECENT_COMMANDS_STORAGE_KEY
Re-exports RESET_LAYOUT
Re-exports RESET_LAYOUT
Re-exports ReactRenderer
Re-exports ReactRenderer
Re-exports ReactTabBarToolbarItem
Re-exports ReactWidget
Re-exports ReactWidget
Re-exports ReadBuffer
Re-exports ReadBuffer
Re-exports RecursivePartial
Re-exports Reference
Re-exports ReferenceCollection
Re-exports ReferenceMutableResource
Re-exports RemoteMeasurement
Re-exports RemoteMeasurement
Re-exports RenderContextMenuOptions
Re-exports RendererHost
Re-exports RendererHost
Re-exports RequestHandler
Re-exports RequestHandler
Re-exports ResolvedConnectionErrorHandlerOptions
Re-exports ResolvedConnectionErrorHandlerOptions
Re-exports ResolvedIPCConnectionOptions
Re-exports ResolvedIPCConnectionOptions
Re-exports ResolvedKeybinding
Re-exports Resource
Re-exports ResourceError
Re-exports ResourceProvider
Re-exports ResourceReadOptions
Re-exports ResourceResolver
Re-exports ResourceSaveOptions
Re-exports ResourceVersion
Re-exports RpcProtocol
Re-exports RpcProtocol
Re-exports RpcProtocolFactory
Re-exports RpcProtocolFactory
Re-exports RpcProtocolOptions
Re-exports RpcProtocolOptions
Re-exports SELECTED_CLASS
Re-exports SELECTED_CLASS
Re-exports SETTINGS_MENU
Re-exports SETTINGS_MENU
Re-exports SHELL_TABBAR_CONTEXT_CLOSE
Re-exports SHELL_TABBAR_CONTEXT_CLOSE
Re-exports SHELL_TABBAR_CONTEXT_COPY
Re-exports SHELL_TABBAR_CONTEXT_COPY
Re-exports SHELL_TABBAR_CONTEXT_MENU
Re-exports SHELL_TABBAR_CONTEXT_MENU
Re-exports SHELL_TABBAR_CONTEXT_PIN
Re-exports SHELL_TABBAR_CONTEXT_PIN
Re-exports SHELL_TABBAR_CONTEXT_SPLIT
Re-exports SHELL_TABBAR_CONTEXT_SPLIT
Re-exports SIDE_PANEL_TOOLBAR_CONTEXT_MENU
Re-exports SIDE_PANEL_TOOLBAR_CONTEXT_MENU
Re-exports STATUSBAR_WIDGET_FACTORY_ID
Re-exports STATUSBAR_WIDGET_FACTORY_ID
Re-exports SaveOptions
Re-exports Saveable
Re-exports SaveableSource
Re-exports SaveableWidget
Re-exports ScopedKeybinding
Re-exports ScrollableRenderData
Re-exports ScrollableRenderData
Re-exports ScrollableTabBar
Re-exports ScrollableTabBar
Re-exports SearchBoxFactoryFactory
Re-exports SearchBoxFactoryFactory
Re-exports SelectableTreeNode
Re-exports SelectableTreeNode
Re-exports SelectionProvider
Re-exports SelectionService
Re-exports ShellLayoutRestorer
Re-exports ShellLayoutRestorer
Re-exports ShouldSaveDialog
Re-exports SideBarRenderData
Re-exports SideBarRenderData
Re-exports SidePanel
Re-exports SidePanel
Re-exports SidePanelHandler
Re-exports SidePanelHandler
Re-exports SidePanelHandlerFactory
Re-exports SidePanelHandlerFactory
Re-exports SideTabBar
Re-exports SideTabBar
Re-exports SidebarBottomMenuWidgetFactory
Re-exports SidebarBottomMenuWidgetFactory
Re-exports SidebarMenu
Re-exports SidebarMenu
Re-exports SidebarMenuWidget
Re-exports SidebarMenuWidget
Re-exports SidebarTopMenuWidgetFactory
Re-exports SidebarTopMenuWidgetFactory
Re-exports SingleTextInputDialog
Re-exports SingleTextInputDialogProps
Re-exports SizeData
Re-exports SizeData
Re-exports SourceTree
Re-exports SourceTreeWidget
Re-exports SpecialCases
Re-exports SpecialCases
Re-exports SpecialCases
Re-exports SpecialCases
Re-exports SplitPositionHandler
Re-exports SplitPositionHandler
Re-exports SplitPositionOptions
Re-exports SplitPositionOptions
Re-exports StatefulWidget
Re-exports StatefulWidget
Re-exports StatusBar
Re-exports StatusBar
Re-exports StatusBar
Re-exports StatusBarAffinity
Re-exports StatusBarAffinity
Re-exports StatusBarAlignment
Re-exports StatusBarAlignment
Re-exports StatusBarAlignment
Re-exports StatusBarEntry
Re-exports StatusBarEntry
Re-exports StatusBarEntry
Re-exports StatusBarImpl
Re-exports StatusBarImpl
Re-exports StatusBarViewEntry
Re-exports StatusBarViewEntry
Re-exports StatusBarViewModel
Re-exports StatusBarViewModel
Re-exports StatusBarViewModelEntry
Re-exports StatusBarViewModelEntry
Re-exports Stopwatch
Re-exports Stopwatch
Re-exports StorageService
Re-exports Styles
Re-exports Styles
Re-exports StylingParticipant
Re-exports StylingService
Re-exports SubMenuOptions
Re-exports SubMenuOptions
Re-exports SyncReferenceCollection
Re-exports TAB_BAR_TOOLBAR_CONTEXT_MENU
Re-exports TREE_CLASS
Re-exports TREE_CLASS
Re-exports TREE_CONTAINER_CLASS
Re-exports TREE_CONTAINER_CLASS
Re-exports TREE_NODE_CAPTION_CLASS
Re-exports TREE_NODE_CAPTION_CLASS
Re-exports TREE_NODE_CLASS
Re-exports TREE_NODE_CLASS
Re-exports TREE_NODE_CONTENT_CLASS
Re-exports TREE_NODE_CONTENT_CLASS
Re-exports TREE_NODE_INDENT_GUIDE_CLASS
Re-exports TREE_NODE_INDENT_GUIDE_CLASS
Re-exports TREE_NODE_INFO_CLASS
Re-exports TREE_NODE_INFO_CLASS
Re-exports TREE_NODE_SEGMENT_CLASS
Re-exports TREE_NODE_SEGMENT_CLASS
Re-exports TREE_NODE_SEGMENT_GROW_CLASS
Re-exports TREE_NODE_SEGMENT_GROW_CLASS
Re-exports TREE_NODE_TAIL_CLASS
Re-exports TREE_NODE_TAIL_CLASS
Re-exports TabBarDelegator
Re-exports TabBarRenderer
Re-exports TabBarRenderer
Re-exports TabBarRendererFactory
Re-exports TabBarRendererFactory
Re-exports TabBarToolbar
Re-exports TabBarToolbarContribution
Re-exports TabBarToolbarFactory
Re-exports TabBarToolbarItem
Re-exports TabBarToolbarRegistry
Re-exports TelemetryLogger
Re-exports TelemetryTrustedValue
Re-exports TextDocumentContentChangeDelta
Re-exports ToolbarAwareTabBar
Re-exports ToolbarAwareTabBar
Re-exports TooltipAttributes
Re-exports TooltipService
Re-exports TooltipServiceImpl
Re-exports TopDownCompressedTreeIterator
Re-exports TopDownCompressedTreeIterator
Re-exports TopDownCompressedTreeIterator
Re-exports TopDownTreeIterator
Re-exports TopDownTreeIterator
Re-exports Tree
Re-exports Tree
Re-exports TreeCompressionService
Re-exports TreeCompressionService
Re-exports TreeCompressionService
Re-exports TreeContainerProps
Re-exports TreeContainerProps
Renames and re-exports WidgetDecoration
Renames and re-exports WidgetDecoration
Renames and re-exports WidgetDecoration
Re-exports TreeDecorator
Re-exports TreeDecorator
Re-exports TreeDecoratorService
Re-exports TreeDecoratorService
Re-exports TreeElement
Re-exports TreeElementNode
Re-exports TreeElementNodeParent
Re-exports TreeExpansionService
Re-exports TreeExpansionService
Re-exports TreeExpansionServiceImpl
Re-exports TreeExpansionServiceImpl
Re-exports TreeIdentifiers
Re-exports TreeIdentifiers
Re-exports TreeImpl
Re-exports TreeImpl
Re-exports TreeIterator
Re-exports TreeIterator
Re-exports TreeModel
Re-exports TreeModel
Re-exports TreeModelImpl
Re-exports TreeModelImpl
Re-exports TreeNavigationService
Re-exports TreeNavigationService
Re-exports TreeNode
Re-exports TreeNode
Re-exports TreeProps
Re-exports TreeProps
Re-exports TreeSearch
Re-exports TreeSearch
Re-exports TreeSelection
Re-exports TreeSelection
Re-exports TreeSelectionService
Re-exports TreeSelectionService
Re-exports TreeSource
Re-exports TreeSourceNode
Re-exports TreeSourceOptions
Re-exports TreeViewWelcomeWidget
Re-exports TreeViewWelcomeWidget
Re-exports TreeWidget
Re-exports TreeWidget
Re-exports UNTITLED_SCHEME
Re-exports URI
Re-exports URIIconReference
Re-exports UnsafeWidgetUtilities
Re-exports UnsafeWidgetUtilities
Re-exports UntitledResource
Re-exports UntitledResourceResolver
Re-exports UriSelection
Re-exports ValidatablePreference
Re-exports ValidatablePreference
Re-exports ValueValidator
Re-exports ValueValidator
Re-exports ViewColumn
Re-exports ViewContainer
Re-exports ViewContainerIdentifier
Re-exports ViewContainerLayout
Re-exports ViewContainerPart
Re-exports ViewContainerTitleOptions
Re-exports ViewContributionOptions
Re-exports ViewContributionOptions
Re-exports WaitUntilData
Re-exports WaitUntilEvent
Re-exports WebSocketConnectionProvider
Re-exports WebSocketConnectionProvider
Re-exports WebSocketOptions
Re-exports WebSocketOptions
Re-exports WidgetConstructionOptions
Re-exports WidgetDescription
Re-exports WidgetDescription
Re-exports WidgetFactory
Re-exports WidgetManager
Re-exports WidgetOpenHandler
Re-exports WidgetOpenMode
Re-exports WidgetOpenerOptions
Re-exports WillCreateWidgetEvent
Re-exports WillExecuteCommandEvent
Re-exports WriteBuffer
Re-exports WriteBuffer
Re-exports addClipboardListener
Re-exports addClipboardListener
Re-exports addEventListener
Re-exports addEventListener
Re-exports addKeyListener
Re-exports addKeyListener
Re-exports animationFrame
Re-exports applicationShellLayoutVersion
Re-exports applicationShellLayoutVersion
Re-exports bindBackendStopwatch
Re-exports bindBackendStopwatchServer
Re-exports bindContribution
Re-exports bindContributionProvider
Re-exports bindCorePreferences
Re-exports bindFrontendStopwatch
Re-exports bindMessageService
Re-exports bindMockPreferenceProviders
Re-exports bindNodeStopwatch
Re-exports bindPreferenceSchemaProvider
Re-exports bindPreferenceSchemaProvider
Re-exports bindPreferenceService
Re-exports bindResourceProvider
Re-exports bindStatusBar
Re-exports bindViewContribution
Re-exports bindViewContribution
Re-exports cancelled
Re-exports checkCancelled
Re-exports cloneAndChange
Re-exports close
Re-exports cmd
Re-exports codicon
Re-exports codicon
Re-exports codiconArray
Re-exports codiconArray
Re-exports commandServicePath
Re-exports commonPrefixLength
Re-exports compare
Re-exports compareIgnoreCase
Re-exports compareSubstring
Re-exports compareSubstringIgnoreCase
Re-exports confirmExit
Re-exports confirmExitWithOrWithoutSaving
Re-exports coordinateFromAnchor
Re-exports corePreferenceSchema
Re-exports createCorePreferences
Re-exports createIconButton
Re-exports createIconButton
Re-exports createMockPreferenceProxy
Re-exports createPreferenceProxy
Re-exports createPreferenceProxy
Re-exports createTreeContainer
Re-exports createTreeContainer
Re-exports createUntitledURI
Re-exports deepClone
Re-exports deepFreeze
Renames and re-exports URI
Renames and re-exports start
Re-exports defaultTreeProps
Re-exports defaultTreeProps
Re-exports disposableTimeout
Re-exports endsWith
Re-exports envVariablesPath
Re-exports equalsIgnoreCase
Re-exports escapeIcons
Re-exports escapeInvisibleChars
Re-exports escapeMarkdownSyntaxTokens
Re-exports escapeRegExpCharacters
Re-exports filterItems
Re-exports filterItems
Re-exports filterItems
Re-exports filterItems
Re-exports findMatches
Re-exports findMatches
Re-exports findMatches
Re-exports findMatches
Re-exports getOverridePattern
Re-exports getOverridePattern
Re-exports isArray
Re-exports isBasicWasmSupported
Re-exports isBoolean
Re-exports isCancelled
Re-exports isChrome
Re-exports isEdge
Re-exports isEdgeOrIE
Re-exports isEmpty
Re-exports isError
Re-exports isErrorLike
Re-exports isFirefox
Re-exports isFunction
Re-exports isIE
Re-exports isIPad
Re-exports isLowerAsciiLetter
Re-exports isNative
Re-exports isNumber
Re-exports isOSX
Re-exports isObject
Re-exports isOpera
Re-exports isPinned
Re-exports isPinned
Re-exports isSafari
Re-exports isString
Re-exports isStringArray
Re-exports isTreeServices
Re-exports isTreeServices
Re-exports isUndefined
Re-exports isUpperAsciiLetter
Re-exports isWebKit
Re-exports isWindows
Re-exports lock
Re-exports lock
Re-exports logger
Re-exports measureTextHeight
Re-exports measureTextWidth
Re-exports messageServicePath
Re-exports nls
Re-exports notEmpty
Re-exports nullToUndefined
Re-exports open
Re-exports parseCssMagnitude
Re-exports parseCssTime
Re-exports pin
Re-exports pin
Re-exports preventNavigation
Re-exports quickCommand
Re-exports quickCommand
Re-exports quickPickServicePath
Re-exports quickPickServicePath
Re-exports quickPickServicePath
Re-exports quickPickServicePath
Re-exports rootLoggerName
Re-exports rootLoggerName
Re-exports setDirty
Re-exports setEnabled
Re-exports setEnabled
Re-exports setRootLogger
Re-exports split
Re-exports startsWithIgnoreCase
Re-exports stopwatchPath
Re-exports stopwatchPath
Re-exports supportCopy
Re-exports supportCut
Re-exports supportPaste
Re-exports toAnchor
Re-exports togglePinned
Re-exports togglePinned
Re-exports unescapeInvisibleChars
Re-exports unpin
Re-exports unpin
Re-exports unreachable
Re-exports unsetRootLogger
Re-exports waitForClosed
Re-exports waitForClosed
Re-exports waitForHidden
Re-exports waitForHidden
Re-exports waitForRevealed
Re-exports waitForRevealed

Type Aliases

Anchor: MouseEvent | Coordinate
ApplicationShellLayoutVersion: 2 | 3 | 4 | 5 | 6
BindBackendService: (<T, C>(path: string, serviceIdentifier: interfaces.ServiceIdentifier<T>, onActivation?: ((service: T, proxy: JsonRpcProxy<C>) => T)) => void)

Type declaration

    • <T, C>(path: string, serviceIdentifier: interfaces.ServiceIdentifier<T>, onActivation?: ((service: T, proxy: JsonRpcProxy<C>) => T)): void
    • Type Parameters

      • T extends object

      • C extends object = object

      Parameters

      • path: string
      • serviceIdentifier: interfaces.ServiceIdentifier<T>
      • Optional onActivation: ((service: T, proxy: JsonRpcProxy<C>) => T)

      Returns void

BindFrontendService: (<T>(path: string, serviceIdentifier: interfaces.ServiceIdentifier<T>) => interfaces.BindingWhenOnSyntax<T>)

Type declaration

    • <T>(path: string, serviceIdentifier: interfaces.ServiceIdentifier<T>): interfaces.BindingWhenOnSyntax<T>
    • Type Parameters

      • T extends object

      Parameters

      • path: string
      • serviceIdentifier: interfaces.ServiceIdentifier<T>

      Returns interfaces.BindingWhenOnSyntax<T>

Bindable: interfaces.Bind | interfaces.Container
BreadcrumbID: string
CMD: [string, string[]]
Color: string | RGBA | HSLA | ColorTransformation

Either be a reference to an existing color or a color value as a hex string, rgba, or hsla.

CompressionParticipant: CompressionChild | CompressionParent
ConnectionContainerModuleCallBack: ((registry: { bind: interfaces.Bind; bindBackendService: BindBackendService; bindFrontendService: BindFrontendService; isBound: interfaces.IsBound; rebind: interfaces.Rebind; unbind: interfaces.Unbind }) => void)

Type declaration

    • (registry: { bind: interfaces.Bind; bindBackendService: BindBackendService; bindFrontendService: BindFrontendService; isBound: interfaces.IsBound; rebind: interfaces.Rebind; unbind: interfaces.Unbind }): void
    • Parameters

      • registry: { bind: interfaces.Bind; bindBackendService: BindBackendService; bindFrontendService: BindFrontendService; isBound: interfaces.IsBound; rebind: interfaces.Rebind; unbind: interfaces.Unbind }

      Returns void

ConnectionErrorHandlerOptions: Partial<ResolvedConnectionErrorHandlerOptions> & { logger: ILogger; serverName: string }
Constructor<T>: (new (...params: unknown[]) => T)

Type Parameters

  • T

Type declaration

    • new (...params: unknown[]): T
    • Parameters

      • Rest ...params: unknown[]

      Returns T

ContextKeyValue: null | undefined | boolean | number | string | (null | undefined | boolean | number | string)[] | Record<string, null | undefined | boolean | number | string>
ContributionType: interfaces.ServiceIdentifier<any>
CustomTitleWidgetFactory: (() => Widget | undefined)

Type declaration

    • (): Widget | undefined
    • Returns Widget | undefined

Deferred<T>: { [ P in keyof T]: Promise<T[P]> }

Type Parameters

  • T

DialogError: string | boolean | { message: string; result: boolean }
DialogMode: "open" | "preview"
DisposableGroup: { push: any } | { add: any }
ElectronMenuItemRole: "undo" | "redo" | "cut" | "copy" | "paste" | "pasteAndMatchStyle" | "delete" | "selectAll" | "reload" | "forceReload" | "toggleDevTools" | "resetZoom" | "zoomIn" | "zoomOut" | "togglefullscreen" | "window" | "minimize" | "close" | "help" | "about" | "services" | "hide" | "hideOthers" | "unhide" | "quit" | "startSpeaking" | "stopSpeaking" | "zoom" | "front" | "appMenu" | "fileMenu" | "editMenu" | "viewMenu" | "recentDocuments" | "toggleTabBar" | "selectNextTab" | "selectPreviousTab" | "mergeAllWindows" | "clearRecentDocuments" | "moveTabToNewWindow" | "windowMenu"

Define the action of the menu item, when specified the click property will be ignored. See roles.

ElectronWindowPreferences: PreferenceProxy<ElectronWindowConfiguration>
EventListener<K>: ((this: HTMLElement, event: HTMLElementEventMap[K]) => any)

Type Parameters

  • K extends keyof HTMLElementEventMap

Type declaration

    • (this: HTMLElement, event: HTMLElementEventMap[K]): any
    • Parameters

      • this: HTMLElement
      • event: HTMLElementEventMap[K]

      Returns any

EventListenerOrEventListenerObject<K>: EventListener<K> | EventListenerObject<K>

Type Parameters

  • K extends keyof HTMLElementEventMap

Filter<T>: ((toTest: T) => boolean)

Type Parameters

  • T extends Object

Type declaration

    • (toTest: T): boolean
    • Parameters

      • toTest: T

        Object that should be tested

      Returns boolean

      true if the object passes the test, false otherwise.

FormatType: string | number | boolean | undefined
FrontendApplicationState: "init" | "started_contributions" | "attached_shell" | "initialized_layout" | "ready" | "closing_window"
HoverPosition: "left" | "right" | "top" | "bottom"
IPCConnectionOptions: Partial<ResolvedIPCConnectionOptions> & { entryPoint: string; serverName: string }
IPCEntryPoint: ((connection: Channel) => void)

Type declaration

InternalMenuDto: Omit<MenuDto, "execute" | "submenu"> & { handlerId?: number; submenu?: InternalMenuDto[] }
JsonRpcProxy<T>: T & JsonRpcConnectionEventEmitter

Type Parameters

  • T

JsonRpcServer<Client>: Disposable & { getClient?: any; setClient: any }

Type Parameters

  • Client

JsonType: "string" | "array" | "number" | "integer" | "object" | "boolean" | "null"
KeySequence: KeyCode[]
Keybinding: Keybinding
deprecated

import from @theia/core/lib/common/keybinding instead

KeyboardLayoutSource: "navigator.keyboard" | "user-choice" | "pressed-keys"
KeysOrKeyCodes: Key | KeyCode | (Key | KeyCode)[]
LabelPart: string | LabelIcon
Log: ((message: any, ...params: any[]) => void)

Type declaration

    • (message: any, ...params: any[]): void
    • Parameters

      • message: any
      • Rest ...params: any[]

      Returns void

Loggable: ((log: Log) => void)

Type declaration

    • (log: Log): void
    • Parameters

      Returns void

LoggerFactory: ((name: string) => ILogger)

Type declaration

MaybeArray<T>: T | T[]

Type Parameters

  • T

MaybeNull<T>: { [ P in keyof T]: T[P] | null }

Type Parameters

  • T

MaybePromise<T>: T | PromiseLike<T>

Type Parameters

  • T

MaybeUndefined<T>: { [ P in keyof T]?: T[P] }

Type Parameters

  • T

MenuCommandArguments: [menuPath: MenuPath, command: string, commandArgs: unknown[]]

Base interface of the nodes used in the menu tree structure.

MenuPath: string[]
MenuRole: "undo" | "redo" | "cut" | "copy" | "paste" | "selectAll" | "about" | "services" | "hide" | "hideOthers" | "unhide" | "quit"
MessageProvider: (() => ReadBuffer)

Type declaration

    • The MessageProvider is emitted when a channel receives a new message. Listeners can invoke the provider to obtain a new ReadBuffer for the received message. This ensures that each listener has its own isolated ReadBuffer instance.

      Returns ReadBuffer

MessageType: keyof AlertMessageIcon
Mutable<T>: { -readonly [ P in keyof T]: T[P] }

Type Parameters

  • T

NavigatableWidget: BaseWidget & Navigatable
ParsedExpression: ((path: string, basename?: string, hasSibling?: ((name: string) => boolean | Promise<boolean>)) => string | Promise<string>)

Type declaration

    • (path: string, basename?: string, hasSibling?: ((name: string) => boolean | Promise<boolean>)): string | Promise<string>
    • Parameters

      • path: string
      • Optional basename: string
      • Optional hasSibling: ((name: string) => boolean | Promise<boolean>)
          • (name: string): boolean | Promise<boolean>
          • Parameters

            • name: string

            Returns boolean | Promise<boolean>

      Returns string | Promise<string>

ParsedPattern: ((path: string, basename?: string) => boolean)

Type declaration

    • (path: string, basename?: string): boolean
    • Parameters

      • path: string
      • Optional basename: string

      Returns boolean

PartialCSSStyle: Omit<Partial<CSSStyleDeclaration>, "visibility" | "display" | "parentRule" | "getPropertyPriority" | "getPropertyValue" | "item" | "removeProperty" | "setProperty">
PreferenceChangeEvent<T>: { affects: any } & { [ K in keyof T]-?: { newValue: T[K]; oldValue?: T[K]; preferenceName: K } }[keyof T]

Union of all possible key/value pairs for a type T

Type Parameters

  • T

PreferenceInspectionScope: keyof Omit<PreferenceInspection<unknown>, "preferenceName">
PreferenceProviderProvider: ((scope: PreferenceScope, uri?: URI) => PreferenceProvider)

Type declaration

PreferenceProxy<T>: Readonly<T> & Disposable & PreferenceEventEmitter<T> & PreferenceRetrieval<T>

Typesafe schema-based preferences utility based on the PreferenceService. Can be used to get preferences as well as listen to preference changes.

See createPreferenceProxy on how to instantiate preference proxies.

Example usage

preferences.onPreferenceChanged(({ preferenceName, newValue }) => { ... });
const enabled = preferences['myext.enabled'];

Type Parameters

  • T

QuickPickInput<T>: T | QuickPickSeparator

Type Parameters

QuickPickItemOrSeparator: QuickPickItem | QuickPickSeparator
RecursivePartial<T>: { [ P in keyof T]?: T[P] extends (infer I)[] ? RecursivePartial<I>[] : RecursivePartial<T[P]> }

Type Parameters

  • T

RemoteMeasurement: number

Token representing a remote measurement in the BackendStopwatch protocol.

RendererHost: HTMLElement
RequestHandler: ((method: string, args: any[]) => Promise<any>)

Type declaration

    • (method: string, args: any[]): Promise<any>
    • Handles request messages received by the RPCProtocol.

      Parameters

      • method: string
      • args: any[]

      Returns Promise<any>

ResourceProvider: ((uri: URI) => Promise<Resource>)

Type declaration

This code lets you encode rpc protocol messages (request/reply/notification/error/cancel) into a channel write buffer and decode the same messages from a read buffer. Custom encoders/decoders can be registered to specially handling certain types of values to be encoded. Clients are responsible for ensuring that the set of tags for encoders is distinct and the same at both ends of a channel.

RpcProtocolFactory: ((channel: Channel, requestHandler: RequestHandler) => RpcProtocol)

Type declaration

ScopedValueStore: Omit<ContextKeyService, "onDidChange" | "match" | "parseKeys" | "with" | "createOverlay">
TabBarRendererFactory: (() => TabBarRenderer)

Type declaration

ThemeType: "light" | "dark" | "hc" | "hcLight"
TreeElementNodeParent: CompositeTreeElementNode | TreeSourceNode
TreeIdentifiers: { [ K in keyof TreeTypes]: interfaces.ServiceIdentifier<TreeTypes[K]> }
TreeWidgetSelection: ReadonlyArray<Readonly<SelectableTreeNode>> & { source: TreeWidget }
ValueValidator: ((value: JSONValue) => JSONValue)

Type declaration

    • (value: JSONValue): JSONValue
    • Parameters

      • value: JSONValue

      Returns JSONValue

WaitUntilData<T>: Omit<T, "waitUntil" | "token">

Type Parameters

  • T

WidgetOpenMode: "open" | "reveal" | "activate"
WindowApplicationConfig: FrontendApplicationConfig
WindowEvent: "maximize" | "unmaximize" | "focus"

Variables

ABOUT_CONTENT_CLASS: "theia-aboutDialog" = 'theia-aboutDialog'
ABOUT_EXTENSIONS_CLASS: "theia-aboutExtensions" = 'theia-aboutExtensions'
ACCOUNTS_MENU: MenuPath = ...
ACCOUNTS_SUBMENU: string[] = ...
ACTION_ITEM: "action-label" = 'action-label'
ACTIVE_TABBAR_CLASS: "theia-tabBar-active" = 'theia-tabBar-active'
ApplicationServer: typeof ApplicationServer = ...
ApplicationShellLayoutMigration: typeof ApplicationShellLayoutMigration = ...
ApplicationShellOptions: typeof ApplicationShellOptions = ...
AsyncLocalizationProvider: typeof AsyncLocalizationProvider = ...
AuthenticationService: typeof AuthenticationService = ...
BOTTOM_AREA_ID: "theia-bottom-content-panel" = 'theia-bottom-content-panel'
BUSY_CLASS: "theia-mod-busy" = 'theia-mod-busy'
BackendApplicationContribution: typeof BackendApplicationContribution = ...
BackendApplicationServer: typeof BackendApplicationServer = ...
BackendStopwatch: typeof BackendStopwatch = ...
BackendStopwatchOptions: typeof BackendStopwatchOptions = ...
BreadcrumbID: typeof BreadcrumbID
BreadcrumbPopupContainerFactory: typeof BreadcrumbPopupContainerFactory
BreadcrumbRenderer: typeof BreadcrumbRenderer = ...
BreadcrumbsContribution: typeof BreadcrumbsContribution = ...
BreadcrumbsRendererFactory: typeof BreadcrumbsRendererFactory = ...
CHANNEL_APP_STATE_CHANGED: "ApplicationStateChanged" = 'ApplicationStateChanged'
CHANNEL_ATTACH_SECURITY_TOKEN: "AttachSecurityToken" = 'AttachSecurityToken'
CHANNEL_CLOSE: "Close" = 'Close'
CHANNEL_CLOSE_POPUP: "ClosePopup" = 'ClosePopup'
CHANNEL_FOCUS_WINDOW: "FocusWindow" = 'FocusWindow'
CHANNEL_GET_SECURITY_TOKEN: "GetSecurityToken" = 'GetSecurityToken'
CHANNEL_GET_TITLE_STYLE_AT_STARTUP: "GetTitleStyleAtStartup" = 'GetTitleStyleAtStartup'
CHANNEL_GET_ZOOM_LEVEL: "GetZoomLevel" = 'GetZoomLevel'
CHANNEL_INVOKE_MENU: "InvokeMenu" = 'InvokeMenu'
CHANNEL_IPC_CONNECTION: "IpcConnection" = 'IpcConnection'
CHANNEL_IS_FULL_SCREEN: "IsFullScreen" = 'IsFullScreen'
CHANNEL_IS_FULL_SCREENABLE: "IsFullScreenable" = 'IsFullScreenable'
CHANNEL_IS_MAXIMIZED: "IsMaximized" = 'IsMaximized'
CHANNEL_KEYBOARD_LAYOUT_CHANGED: "KeyboardLayoutChanged" = 'KeyboardLayoutChanged'
CHANNEL_MAXIMIZE: "Maximize" = 'Maximize'
CHANNEL_MINIMIZE: "Minimize" = 'Minimize'
CHANNEL_ON_CLOSE_POPUP: "OnClosePopup" = 'OnClosePopup'
CHANNEL_ON_WINDOW_EVENT: "OnWindowEvent" = 'OnWindowEvent'
CHANNEL_OPEN_POPUP: "OpenPopup" = 'OpenPopup'
CHANNEL_READ_CLIPBOARD: "ReadClipboard" = 'ReadClipboard'
CHANNEL_REQUEST_CLOSE: "RequestClose" = 'RequestClose'
CHANNEL_REQUEST_RELOAD: "RequestReload" = 'RequestReload'
CHANNEL_REQUEST_SECONDARY_CLOSE: "RequestSecondaryClose" = 'RequestSecondaryClose'
CHANNEL_RESTART: "Restart" = 'Restart'
CHANNEL_SET_MENU: "SetMenu" = 'SetMenu'
CHANNEL_SET_MENU_BAR_VISIBLE: "SetMenuBarVisible" = 'SetMenuBarVisible'
CHANNEL_SET_TITLE_STYLE: "SetTitleStyle" = 'SetTitleStyle'
CHANNEL_SET_ZOOM_LEVEL: "SetZoomLevel" = 'SetZoomLevel'
CHANNEL_SHOW_ITEM_IN_FOLDER: "ShowItemInFolder" = 'ShowItemInFolder'
CHANNEL_SHOW_OPEN: "ShowOpenDialog" = 'ShowOpenDialog'
CHANNEL_SHOW_SAVE: "ShowSaveDialog" = 'ShowSaveDialog'
CHANNEL_TOGGLE_DEVTOOLS: "ToggleDevtools" = 'ToggleDevtools'
CHANNEL_TOGGLE_FULL_SCREEN: "ToggleFullScreen" = 'ToggleFullScreen'
CHANNEL_UNMAXIMIZE: "UnMaximize" = 'UnMaximize'
CHANNEL_WRITE_CLIPBOARD: "WriteClipboard" = 'WriteClipboard'
CLEAR_COMMAND_HISTORY: Command = ...
CLOSE_QUICK_OPEN: Command = ...
CODICON_LOADING_CLASSES: string[] = ...
CODICON_TREE_ITEM_CLASSES: string[] = ...
COLLAPSED_CLASS: "theia-mod-collapsed" = 'theia-mod-collapsed'
COMPOSITE_TREE_NODE_CLASS: "theia-CompositeTreeNode" = 'theia-CompositeTreeNode'
CliContribution: typeof CliContribution = ...
ClipboardService: typeof ClipboardService = ...
ColorContribution: typeof ColorContribution = ...
CommandContribution: typeof CommandContribution = ...
CommandService: typeof CommandService = ...
CompressionToggle: typeof CompressionToggle = ...
ConnectionContainerModule: symbol & { create: any } = ...

It provides bindings which are scoped per a connection, e.g. in order to allow backend services to access frontend service within the same connection.

Binding a frontend service

const myConnectionModule = ConnectionContainerModule.create(({ bindFrontendService }) => {
bindFrontendService(myFrontendServicePath, MyFrontendService);
});

export const myBackendApplicationModule = new ContainerModule(bind => {
bind(ConnectionContainerModule).toConstantValue(myConnectionModule);
}

Exposing a backend service

const myConnectionModule2 = ConnectionContainerModule.create(({ bind, bindBackendService }) => {
bind(MyBackendService).toSelf().inSingletonScope();
bindBackendService(myBackendServicePath, MyBackendService);
});

export const myBackendApplicationModule2 = new ContainerModule(bind => {
bind(ConnectionContainerModule).toConstantValue(myConnectionModule2);
}

Injecting a frontend service

@injectable()
export class MyBackendService {
@inject(MyFrontendService)
protected readonly myFrontendService: MyFrontendService;
}
ConnectionHandler: typeof ConnectionHandler = ...
ConnectionStatusService: typeof ConnectionStatusService = ...

Service for listening on backend connection changes.

ContextKeyService: typeof ContextKeyService = ...
ContributionFilterRegistry: typeof ContributionFilterRegistry = ...
ContributionProvider: typeof ContributionProvider = ...
Coordinate: typeof Coordinate
CorePreferenceContribution: typeof CorePreferenceContribution = ...
CorePreferences: typeof CorePreferences = ...
CredentialsService: typeof CredentialsService = ...
CustomTitleWidgetFactory: typeof CustomTitleWidgetFactory = ...
DEBUG_MODE: boolean = ...
DEFAULT_BACKGROUND_COLOR_STORAGE_KEY: "theme.background" = 'theme.background'
DEFAULT_LAYOUT_DATA: KeyboardLayoutData = ...

This is the fallback keyboard layout selected when nothing else matches. It has an empty mapping, so user inputs are handled like with a standard US keyboard.

DEFAULT_SCROLL_OPTIONS: PerfectScrollbar.Options = ...
DEFAULT_WINDOW_HASH: string = '!empty'

The window hash value that is used to spawn a new default window.

DISABLED_CLASS: "theia-mod-disabled" = 'theia-mod-disabled'
DecorationsService: typeof DecorationsService = ...
DockPanelRendererFactory: typeof DockPanelRendererFactory = ...
EXPANDABLE_TREE_NODE_CLASS: "theia-ExpandableTreeNode" = 'theia-ExpandableTreeNode'
EXPANSION_TOGGLE_CLASS: "theia-ExpansionToggle" = 'theia-ExpansionToggle'
ElectronConnectionHandler: typeof ElectronConnectionHandler = ...

Electron-IPC-specific connection handler. Use this if you want to establish communication between the frontend and the electron-main process.

ElectronMainApplicationContribution: typeof ElectronMainApplicationContribution = ...

The default entrypoint will handle a very rudimentary CLI to open workspaces by doing app path/to/workspace. To override this behavior, you can extend and rebind the ElectronMainApplication class and overriding the launch method. A JSON-RPC communication between the Electron Main Process and the Renderer Processes is available: You can bind services using the ElectronConnectionHandler and ElectronIpcConnectionProvider APIs, example:

From an electron-main module:

bind(ElectronConnectionHandler).toDynamicValue(context =>
new JsonRpcConnectionHandler(electronMainWindowServicePath,
() => context.container.get(ElectronMainWindowService))
).inSingletonScope();

And from the electron-browser module:

bind(ElectronMainWindowService).toDynamicValue(context =>
ElectronIpcConnectionProvider.createProxy(context.container, electronMainWindowServicePath)
).inSingletonScope();
ElectronMainApplicationGlobals: typeof ElectronMainApplicationGlobals = ...
ElectronMainWindowService: typeof ElectronMainWindowService = ...
ElectronSecurityToken: string = 'THEIA_ELECTRON_TOKEN'

This token is unique to the current running instance. It is used by the backend to make sure it is an electron browser window that is connecting to its services.

The identifier is a string, which makes it usable as a key for cookies, environments, etc.

ElectronWindowPreferenceContribution: typeof ElectronWindowPreferenceContribution = ...
ElectronWindowPreferences: typeof ElectronWindowPreferences = ...
EnvVariablesServer: typeof EnvVariablesServer = ...
FOCUS_CLASS: "theia-mod-focus" = 'theia-mod-focus'
FileSystemLocking: symbol & Abstract<FileSystemLocking> = ...
Filter: typeof Filter = ...
FilterContribution: typeof FilterContribution = ...
FrontendApplicationContribution: typeof FrontendApplicationContribution = ...

Clients can implement to get a callback for contributing widgets to a shell on start.

ILogger: typeof ILogger = ...
ILoggerClient: typeof ILoggerClient = ...
ILoggerServer: typeof ILoggerServer = ...
IconThemeContribution: typeof IconThemeContribution = ...
InitialWindowTitleParts: { activeEditorLong: undefined; activeEditorMedium: undefined; activeEditorShort: undefined; activeFolderLong: undefined; activeFolderMedium: undefined; activeFolderShort: undefined; appName: string; developmentHost: undefined; dirty: undefined; folderName: undefined; folderPath: undefined; remoteName: undefined; rootName: undefined; rootPath: undefined } = ...

Type declaration

  • activeEditorLong: undefined
  • activeEditorMedium: undefined
  • activeEditorShort: undefined
  • activeFolderLong: undefined
  • activeFolderMedium: undefined
  • activeFolderShort: undefined
  • appName: string
  • developmentHost: undefined
  • dirty: undefined
  • folderName: undefined
  • folderPath: undefined
  • remoteName: undefined
  • rootName: undefined
  • rootPath: undefined
JsonSchemaContribution: typeof JsonSchemaContribution = ...
KeyValidator: typeof KeyValidator = ...
Keybinding: typeof Keybinding
KeybindingContext: typeof KeybindingContext = ...
KeybindingContribution: typeof KeybindingContribution = ...
KeyboardLayoutChangeNotifier: typeof KeyboardLayoutChangeNotifier = ...
KeyboardLayoutProvider: typeof KeyboardLayoutProvider = ...
KeytarService: typeof KeytarService = ...
LEFT_RIGHT_AREA_CLASS: "theia-app-sides" = 'theia-app-sides'

The class name added to the left and right area panels.

LOCKED_CLASS: "theia-mod-locked" = 'theia-mod-locked'
LabelProviderContribution: typeof LabelProviderContribution = ...
LocalizationContribution: typeof LocalizationContribution = ...
LoggerFactory: typeof LoggerFactory = ...
LoggerName: typeof LoggerName = ...
MAIN_AREA_ID: "theia-main-content-panel" = 'theia-main-content-panel'
MAIN_MENU_BAR: MenuPath = ...
MAXIMIZED_CLASS: "theia-maximized" = 'theia-maximized'
MAX_SAFE_INTEGER: 2147483647 = 2147483647

The maximum safe integer (2^32-1) is used as a placeholder for large numbers which are not allowed to be floats. For example as line/column arguments for monaco-ranges.

MEMORY_TEXT: "mem-txt" = 'mem-txt'
MarkdownRenderer: typeof MarkdownRenderer = ...

Use this directly if you aren't worried about circular dependencies in the Shell

MarkdownRendererFactory: typeof MarkdownRendererFactory = ...

Use this to avoid circular dependencies in the Shell

MenuCommandAdapter: typeof MenuCommandAdapter = ...
MenuCommandAdapterRegistry: typeof MenuCommandAdapterRegistry = ...
MenuCommandExecutor: typeof MenuCommandExecutor = ...
MenuContribution: typeof MenuContribution = ...
MessagingContainer: typeof MessagingContainer = ...
MessagingListenerContribution: typeof MessagingListenerContribution = ...

Bind components to this symbol to subscribe to WebSocket events.

NAVIGATION: "navigation" = 'navigation'

Items whose group is exactly 'navigation' will be rendered inline.

OVERRIDE_PROPERTY_PATTERN: RegExp = ...
OpenHandler: typeof OpenHandler = ...
OpenerService: typeof OpenerService = ...
PINNED_CLASS: "theia-mod-pinned" = 'theia-mod-pinned'
PingService: typeof PingService = ...
PreferenceConfiguration: typeof PreferenceConfiguration = ...
PreferenceContribution: typeof PreferenceContribution = ...
PreferenceProviderProvider: typeof PreferenceProviderProvider = ...

We cannot load providers directly in the case if they depend on PreferenceService somehow. It allows to load them lazily after DI is configured.

PreferenceProxyFactory: typeof PreferenceProxyFactory
PreferenceProxyOptions: typeof PreferenceProxyOptions = ...
PreferenceProxySchema: typeof PreferenceProxySchema = ...
PreferenceService: typeof PreferenceService = ...
ProgressBarFactory: typeof ProgressBarFactory = ...
ProgressBarOptions: typeof ProgressBarOptions = ...
ProgressClient: typeof ProgressClient = ...
ProxyAuthorization: "proxy-authorization" = 'proxy-authorization'
ProxyUrl: "proxy-url" = 'proxy-url'
QuickAccessContribution: typeof QuickAccessContribution = ...
QuickAccessRegistry: typeof QuickAccessRegistry = ...
QuickInputService: typeof QuickInputService = ...
QuickPickService: typeof QuickPickService = ...
RECENT_COMMANDS_STORAGE_KEY: "commands" = 'commands'
RESET_LAYOUT: Command = ...
RendererHost: typeof RendererHost
ResourceProvider: typeof ResourceProvider = ...
ResourceResolver: typeof ResourceResolver = ...
SELECTED_CLASS: "theia-mod-selected" = 'theia-mod-selected'
SELECT_COMPONENT_CONTAINER: "select-component-container" = 'select-component-container'
SETTINGS_MENU: MenuPath = ...
SHELL_TABBAR_CONTEXT_CLOSE: MenuPath = ...
SHELL_TABBAR_CONTEXT_COPY: MenuPath = ...
SHELL_TABBAR_CONTEXT_MENU: MenuPath = ...

Menu path for tab bars used throughout the application shell.

SHELL_TABBAR_CONTEXT_PIN: MenuPath = ...
SHELL_TABBAR_CONTEXT_SPLIT: MenuPath = ...
SIDE_PANEL_TOOLBAR_CONTEXT_MENU: MenuPath = ...
STATUSBAR_WIDGET_FACTORY_ID: "statusBar" = 'statusBar'
SUPPORTED_ENCODINGS: {} = ...

Type declaration

  • [encoding: string]: { alias?: string; encodeOnly?: boolean; labelLong: string; labelShort: string; order: number }
    • Optional alias?: string
    • Optional encodeOnly?: boolean
    • labelLong: string
    • labelShort: string
    • order: number
SearchBoxFactory: typeof SearchBoxFactory = ...

Search box factory.

SecondaryWindowService: typeof SecondaryWindowService = ...
SidePanelHandlerFactory: typeof SidePanelHandlerFactory = ...
SidebarBottomMenuWidgetFactory: typeof SidebarBottomMenuWidgetFactory = ...
SidebarTopMenuWidgetFactory: typeof SidebarTopMenuWidgetFactory = ...
StatusBar: typeof StatusBar = ...
StorageService: typeof StorageService = ...
StrictSSL: "strict-ssl" = 'strict-ssl'
StylingParticipant: typeof StylingParticipant = ...
TAB_BAR_TOOLBAR_CONTEXT_MENU: string[] = ...
TOOLBAR_WRAPPER_ID_SUFFIX: "-as-tabbar-toolbar-item" = '-as-tabbar-toolbar-item'
TREE_CLASS: "theia-Tree" = 'theia-Tree'
TREE_CONTAINER_CLASS: "theia-TreeContainer" = 'theia-TreeContainer'
TREE_NODE_CAPTION_CLASS: "theia-TreeNodeCaption" = 'theia-TreeNodeCaption'
TREE_NODE_CLASS: "theia-TreeNode" = 'theia-TreeNode'
TREE_NODE_CONTENT_CLASS: "theia-TreeNodeContent" = 'theia-TreeNodeContent'
TREE_NODE_INDENT_GUIDE_CLASS: "theia-tree-node-indent" = 'theia-tree-node-indent'
TREE_NODE_INFO_CLASS: "theia-TreeNodeInfo" = 'theia-TreeNodeInfo'
TREE_NODE_SEGMENT_CLASS: "theia-TreeNodeSegment" = 'theia-TreeNodeSegment'
TREE_NODE_SEGMENT_GROW_CLASS: "theia-TreeNodeSegmentGrow" = 'theia-TreeNodeSegmentGrow'
TREE_NODE_TAIL_CLASS: "theia-TreeNodeTail" = 'theia-TreeNodeTail'
TabBarDecorator: typeof TabBarDecorator = ...
TabBarRendererFactory: typeof TabBarRendererFactory = ...
TabBarToolbarContribution: typeof TabBarToolbarContribution = ...

Clients should implement this interface if they want to contribute to the tab-bar toolbar.

TabBarToolbarFactory: typeof TabBarToolbarFactory = ...

Factory for instantiating tab-bar toolbars.

TheiaBrowserWindowOptions: typeof TheiaBrowserWindowOptions
TheiaElectronWindowFactory: typeof TheiaElectronWindowFactory
TooltipService: typeof TooltipService = ...
Tree: typeof Tree = ...
TreeDecoratorService: typeof TreeDecoratorService = ...
TreeExpansionService: typeof TreeExpansionService = ...
TreeFocusService: typeof TreeFocusService
TreeModel: typeof TreeModel = ...

The tree model.

TreeProps: typeof TreeProps = ...
TreeSelectionService: typeof TreeSelectionService = ...

The tree selection service.

UNTITLED_SCHEME: "untitled" = 'untitled'
UTF16be: "utf16be" = 'utf16be'
UTF16be_BOM: number[] = ...
UTF16le: "utf16le" = 'utf16le'
UTF16le_BOM: number[] = ...
UTF8: "utf8" = 'utf8'
UTF8_BOM: number[] = ...
UTF8_with_bom: "utf8bom" = 'utf8bom'
WidgetFactory: typeof WidgetFactory = ...
WindowApplicationConfig: typeof WindowApplicationConfig = ...
WindowService: typeof WindowService = ...

Service for opening new browser windows.

WsRequestValidatorContribution: typeof WsRequestValidatorContribution = ...

Bind components to this symbol to filter WebSocket connections.

applicationPath: "/services/application" = '/services/application'
applicationShellLayoutVersion: ApplicationShellLayoutVersion = 5.0

When a version is increased, make sure to introduce a migration (ApplicationShellLayoutMigration) to this version.

backendApplicationModule: ContainerModule = ...
close: typeof close = ...
commandServicePath: "/services/commands" = '/services/commands'
corePreferenceSchema: PreferenceSchema = ...
default: ContainerModule
default: ContainerModule
default: ContainerModule
default: ContainerModule
default: ContainerModule
default: ContainerModule
default: ContainerModule
default: ContainerModule
default: ContainerModule
default: ContainerModule
default: ContainerModule
default: ContainerModule
default: ContainerModule
default: ContainerModule
default: ContainerModule
default: ContainerModule
default: ContainerModule
default: ContainerModule
defaultMsgPack: Packr = ...
defaultTreeProps: TreeProps = ...

The default tree properties.

electronMainWindowServicePath: "/services/electron-window" = '/services/electron-window'
electronWindowPreferencesSchema: PreferenceSchema = ...
envVariablesPath: "/services/envs" = '/services/envs'
frontendApplicationModule: ContainerModule = ...
ipcEntryPoint: string | undefined = ...
isBasicWasmSupported: boolean = ...
isChrome: boolean = ...
isEdge: boolean = ...
isEdgeOrIE: boolean = ...
isFirefox: boolean = ...
isIE: boolean = ...
isIPad: boolean = ...
isNative: boolean = ...
isOSX: boolean = ...
isOpera: boolean = ...
isSafari: boolean = ...
isWebKit: boolean = ...
isWindows: boolean = ...
keyboardPath: "/services/keyboard" = '/services/keyboard'
keytarServicePath: "/services/keytar" = '/services/keytar'
localizationPath: "/services/i18n" = '/services/i18n'
logger: ILogger
loggerBackendModule: ContainerModule = ...

IMPORTANT: don't use in tests, since it overrides console

loggerFrontendModule: ContainerModule = ...
loggerPath: "/services/logger" = '/services/logger'
messageServicePath: "/services/messageService" = '/services/messageService'
messagingBackendModule: ContainerModule = ...
messagingFrontendModule: ContainerModule = ...
messagingFrontendModule: ContainerModule = ...
nativeSep: "/" | "\\" = ...

The native path separator depending on the OS.

quickCommand: Command = ...
quickPickServicePath: "/services/quickPick" = '/services/quickPick'
rootLoggerName: "root" = 'root'
sep: "/" = '/'

The forward slash path separator.

stopwatchPath: "/services/stopwatch" = '/services/stopwatch'

API path of the stopwatch service that exposes the back-end stopwatch to clients.

supportCopy: boolean = ...
supportCut: boolean = ...
supportPaste: boolean = ...

Functions

  • animationFrame(n?: number): Promise<void>
  • Resolves after the next animation frame if no parameter is given, or after the given number of animation frames.

    Parameters

    • n: number = 1

    Returns Promise<void>

  • basename(path: string): string
  • bindBackendStopwatch(bind: Bind): interfaces.BindingWhenOnSyntax<unknown>
  • bindBackendStopwatchServer(bind: Bind): interfaces.BindingWhenOnSyntax<unknown>
  • bindCommonStylingParticipants(bind: Bind): void
  • bindContribution(bindable: Bindable, service: ServiceIdentifier<any>, contributions: ServiceIdentifier<any>[]): void
  • Helper function to bind a service to a list of contributions easily.

    Parameters

    • bindable: Bindable

      a Container or the bind function directly.

    • service: ServiceIdentifier<any>

      an already bound service to refer the contributions to.

    • contributions: ServiceIdentifier<any>[]

      array of contribution identifiers to bind the service to.

    Returns void

  • bindContributionProvider(bindable: Bindable, id: symbol): void
  • bindCorePreferences(bind: Bind): void
  • bindFrontendStopwatch(bind: Bind): interfaces.BindingWhenOnSyntax<Stopwatch>
  • bindLogger(bind: Bind, props?: { onLoggerServerActivation?: any }): void
  • bindMessageService(bind: Bind): interfaces.BindingWhenOnSyntax<MessageService>
  • bindMockPreferenceProviders(bind: Bind, unbind: Unbind): void
  • bindNodeStopwatch(bind: Bind): interfaces.BindingWhenOnSyntax<Stopwatch>
  • bindPreferenceConfigurations(bind: Bind): void
  • bindPreferenceSchemaProvider(bind: Bind): void
  • bindPreferenceService(bind: Bind): void
  • bindResourceProvider(bind: Bind): void
  • bindStatusBar(bind: Bind): void
  • bindViewContribution<T>(bind: Bind, identifier: Newable<T>): interfaces.BindingWhenOnSyntax<T>
  • bindWindowPreferences(bind: Bind): void
  • cancelled(): Error
  • checkParentAlive(): void
  • cloneAndChange(obj: any, changer: ((orig: any) => any), seen: Set<any>): any
  • cmd(command: string, ...args: string[]): CMD
  • codicon(name: string, actionItem?: boolean): string
  • codiconArray(name: string, actionItem?: boolean): string[]
  • commonPrefixLength(a: string, b: string): number
  • compare(a: string, b: string): number
  • compareIgnoreCase(a: string, b: string): number
  • compareSubstring(a: string, b: string, aStart?: number, aEnd?: number, bStart?: number, bEnd?: number): number
  • compareSubstringIgnoreCase(a: string, b: string, aStart?: number, aEnd?: number, bStart?: number, bEnd?: number): number
  • confirmExit(): Promise<boolean>
  • confirmExitWithOrWithoutSaving(captionsToSave: string[], performSave: (() => Promise<void>)): Promise<boolean>
  • Helper to read a T readable up to a maximum of chunks. If the limit is reached, will return a readable instead to ensure all data can still be read.

    Type Parameters

    • T

    Parameters

    Returns T | Readable<T>

  • createDisposableListener<K>(emitter: EventEmitter, signal: string, handler: ((event: K, ...args: unknown[]) => unknown), collection: DisposableCollection): void
  • createDisposableListener<K>(emitter: EventEmitter, signal: string, handler: ((event: K, ...args: unknown[]) => unknown)): Disposable
  • Type Parameters

    • K

    Parameters

    • emitter: EventEmitter
    • signal: string
    • handler: ((event: K, ...args: unknown[]) => unknown)
        • (event: K, ...args: unknown[]): unknown
        • Parameters

          • event: K
          • Rest ...args: unknown[]

          Returns unknown

    • collection: DisposableCollection

      If a collection is passed in, the new disposable is added to that collection. Otherwise, the new disposable is returned.

    Returns void

  • Type Parameters

    • K

    Parameters

    • emitter: EventEmitter
    • signal: string
    • handler: ((event: K, ...args: unknown[]) => unknown)
        • (event: K, ...args: unknown[]): unknown
        • Parameters

          • event: K
          • Rest ...args: unknown[]

          Returns unknown

    Returns Disposable

  • createIconButton(...classNames: string[]): HTMLSpanElement
  • createIpcEnv(options?: { entryPoint?: string; env?: ProcessEnv }): NodeJS.ProcessEnv
  • createMockPreferenceProxy(preferences: {}): any
  • Creates a preference proxy for typesafe preference handling.

    deprecated

    @since 1.23.0 use PreferenceProxyFactory instead.

    Type Parameters

    • T

    Parameters

    Returns PreferenceProxy<T>

    the created preference proxy.

    Usage

    1. Create JSON Schema specifying your preferences
    2. Create Configuration type based on the JSON Schema
    3. Bind the return value of createPreferenceProxy to make your preferences available wherever needed.

    See CorePreferences for an example.

    Note that if schema is a Promise, most actions will be no-ops until the promise is resolved.

  • createTreeContainer(parent: Container, props?: Partial<TreeContainerProps>): Container
  • createTreeContainer(parent: Container, props?: Partial<TreeProps>): Container
  • createTreeTestContainer(): Container
  • createUntitledURI(extension?: string, parent?: URI): URI
  • deepClone<T>(obj: T): T
  • deepFreeze<T>(obj: T): T
  • delay<T>(ms: number): ((value: T) => Promise<T>)
  • A function to allow a promise resolution to be delayed by a number of milliseconds. Usage is as follows:

    const stringValue = await myPromise.then(delay(600)).then(value => value.toString());

    Type Parameters

    • T

    Parameters

    • ms: number

      the number of millisecond to delay

    Returns ((value: T) => Promise<T>)

    a function that returns a promise that returns the given value, but delayed

      • (value: T): Promise<T>
      • A function to allow a promise resolution to be delayed by a number of milliseconds. Usage is as follows:

        const stringValue = await myPromise.then(delay(600)).then(value => value.toString());

        Parameters

        • value: T

        Returns Promise<T>

        a function that returns a promise that returns the given value, but delayed

  • disposableTimeout(...args: [callback: ((args: void) => void), ms?: number]): Disposable
  • dynamicRequire<T>(id: string): T
  • enableJSDOM(): (() => void)
  • const disableJSDOM = enableJSDOM();
    // actions require DOM
    disableJSDOM();

    Returns (() => void)

      • (): void
      • const disableJSDOM = enableJSDOM();
        // actions require DOM
        disableJSDOM();

        Returns void

  • endsWith(haystack: string, needle: string): boolean
  • equalsIgnoreCase(a: string, b: string): boolean
  • escapeIcons(text: string): string
  • escapeInvisibleChars(value: string): string
  • escapeMarkdownSyntaxTokens(text: string): string
  • escapeRegExpCharacters(value: string): string
  • expectThrowsAsync(actual: Promise<any>, expected?: string | RegExp, message?: string): Promise<void>
  • expectThrowsAsync(actual: Promise<any>, constructor: Function | Error, expected?: string | RegExp, message?: string): Promise<void>
  • extname(path: string): string
  • Filter the list of quick pick items based on the provided filter. Items are filtered based on if:

    • their label satisfies the filter using fuzzy.
    • their description satisfies the filter using fuzzy.
    • their detail satisfies the filter using fuzzy. Filtered items are also updated to display proper highlights based on how they were filtered.

    Parameters

    Returns QuickPickItemOrSeparator[]

    the list of quick pick items that satisfy the filter.

  • findMatches(word: string, pattern: string): { end: number; start: number }[] | undefined
  • Find match highlights when testing a word against a pattern.

    Parameters

    • word: string

      the word to test.

    • pattern: string

      the word to match against.

    Returns { end: number; start: number }[] | undefined

    the list of highlights if present.

  • getClass(filePath: string): string
  • getClassWithColor(filePath: string): string
  • getOverridePattern(identifier: string): string
  • getRoot(path: string, sep?: string): string
  • Computes the root this path, like getRoot('c:\files') === c:\, getRoot('files:///files/path') === files:///, or getRoot('\\server\shares\path') === \\server\shares\

    Parameters

    • path: string
    • sep: string = '/'

    Returns string

  • hasSiblingFn(siblingsFn?: (() => string[])): ((name: string) => boolean) | undefined
  • hasSiblingPromiseFn(siblingsFn?: (() => Promise<string[]>)): ((name: string) => Promise<boolean>) | undefined
  • Parameters

    • Optional siblingsFn: (() => Promise<string[]>)
        • (): Promise<string[]>
        • Returns Promise<string[]>

    Returns ((name: string) => Promise<boolean>) | undefined

  • isArray<T>(value: unknown, every?: ((value: unknown) => unknown), thisArg?: unknown): value is T[]
  • Type Parameters

    • T

    Parameters

    • value: unknown

      value to check.

    • Optional every: ((value: unknown) => unknown)

      optional predicate ran on every element of the array.

        • (value: unknown): unknown
        • Parameters

          • value: unknown

          Returns unknown

    • Optional thisArg: unknown

      value to substitute this with when invoking in the predicate.

    Returns value is T[]

    whether or not value is an array.

  • isBoolean(value: unknown): value is boolean
  • isCancelled(err: undefined | Error): boolean
  • isEmpty(arg: Object): boolean
  • isEqualOrParent(path: string, candidate: string, ignoreCase?: boolean): boolean
  • isError(value: unknown): value is Error
  • isErrorLike(value: unknown): value is Error
  • isFunction<T>(value: unknown): value is T
  • isISOKeyboard(): boolean
  • isLowerAsciiLetter(code: number): boolean
  • isNumber(value: unknown): value is number
  • isObject<T>(value: unknown): value is UnknownObject<T>
  • isPinned(title: Title<Widget>): boolean
  • isString(value: unknown): value is string
  • isStringArray(value: unknown): value is string[]
  • isThenable<T>(obj: unknown): obj is Promise<T>
  • isUndefined(value: unknown): value is undefined
  • isUpperAsciiLetter(code: number): boolean
  • lock(title: Title<Widget>): void
  • match(pattern: string | IRelativePattern, path: string): boolean
  • match(expression: IExpression, path: string, hasSibling?: ((name: string) => boolean)): string
  • Simplified glob matching. Supports a subset of glob patterns:

      • matches anything inside a path segment
    • ? matches 1 character inside a path segment
    • ** matches anything including an empty path segment
    • simple brace expansion ({js,ts} => js or ts)
    • character ranges (using [...])

    Parameters

    Returns boolean

  • Parameters

    • expression: IExpression
    • path: string
    • Optional hasSibling: ((name: string) => boolean)
        • (name: string): boolean
        • Parameters

          • name: string

          Returns boolean

    Returns string

  • measureTextHeight(text: string | string[], style?: PartialCSSStyle): number
  • normalize(path: string, toOSPath?: boolean): string
  • notEmpty<T>(arg: undefined | null | T): arg is T
  • onDidChangeKeyboardLayout(callback: (() => void)): void
  • parseCssMagnitude(value: null | string, defaultValue: number): number
  • Parse a magnitude value (e.g. width, height, left, top) from a CSS attribute value. Returns the given default value (or undefined) if the value cannot be determined, e.g. because it is a relative value like 50% or auto.

    Parameters

    • value: null | string
    • defaultValue: number

    Returns number

  • parseCssTime(time: null | string, defaultValue: number): number
  • Parse the number of milliseconds from a CSS time value. Returns the given default value (or undefined) if the value cannot be determined.

    Parameters

    • time: null | string
    • defaultValue: number

    Returns number

  • Helper to read a T readable up to a maximum of chunks. If the limit is reached, will return a readable instead to ensure all data can still be read.

    Type Parameters

    • T

    Parameters

    Returns T | Readable<T>

  • pin(title: Title<Widget>): void
  • preload(): Promise<void>
  • preload(): void
  • preventNavigation(event: WheelEvent): void
  • registerMsgPackExtensions(): void
  • removeFromCache(filter: ((mod: Module) => boolean)): void
  • Remove all references to a module from Node's module cache.

    Parameters

    • filter: ((mod: Module) => boolean)

      callback to filter modules from the cache: return true to remove the module from the cache.

        • (mod: Module): boolean
        • Parameters

          • mod: Module

          Returns boolean

    Returns void

  • retry<T>(task: (() => Promise<T>), retryDelay: number, retries: number): Promise<T>
  • setDirty(widget: Widget, dirty: boolean): void
  • setEnabled(element: HTMLElement, enabled: boolean): void
  • setRootLogger(aLogger: ILogger): void
  • split(s: string, splitter: string): IterableIterator<string>
  • splitGlobAware(pattern: string, splitChar: string): string[]
  • start(serverModule: MaybePromise<Server<typeof IncomingMessage, typeof ServerResponse> | Server<typeof IncomingMessage, typeof ServerResponse>>): Promise<Address>
  • startsWithIgnoreCase(str: string, candidate: string): boolean
  • timeoutReject<T>(ms: number, message?: string): Promise<T>
  • Creates a promise that is rejected after the given amount of time. A typical use case is to wait for another promise until a specified timeout using:

    Promise.race([ promiseToPerform, timeoutReject(timeout, 'Timeout error message') ]);
    

    Type Parameters

    • T

    Parameters

    • ms: number

      timeout in milliseconds

    • Optional message: string

      error message on promise rejection

    Returns Promise<T>

    rejection promise

  • togglePinned(title?: Title<Widget>): void
  • unescapeInvisibleChars(value: string): string
  • unpin(title: Title<Widget>): void
  • unreachable(_never: never, message?: string): never
  • Throws when called and statically makes sure that all variants of a type were consumed.

    Parameters

    • _never: never
    • message: string = 'unhandled case'

    Returns never

  • unsetRootLogger(): void
  • Counterpart of the #setRootLogger(ILogger). Restores the console.xxx bindings to the original one. Invoking has no side-effect if setRootLogger was not called before. Multiple function invocation has no side-effect either.

    Returns void

  • wait(ms: number): Promise<void>
  • waitForClosed(widget: Widget): Promise<void>
  • waitForEvent<T>(event: Event<T>, ms: number, thisArg?: any, disposables?: Disposable[]): Promise<T>
  • waitForHidden(widget: Widget): Promise<void>
  • waitForRevealed(widget: Widget): Promise<void>