Options
All
  • Public
  • Public/Protected
  • All
Menu

Module plugin-ext

Index

References

Namespaces

Enumerations

Classes

Interfaces

Type Aliases

Variables

Functions

References

Re-exports AnyInputDto
Re-exports ApplyEditsOptions
Re-exports AuthenticationExt
Re-exports AuthenticationMain
Re-exports AuthenticationProviderInformation
Re-exports AutoClosingPair
Re-exports AutoClosingPairConditional
Re-exports AutoFocus
Re-exports BackendInitializationFn
Re-exports BackendLoadingFn
Re-exports BaseTransferQuickInput
Re-exports CharacterPair
Re-exports ClipboardMain
Re-exports CodeActionDto
Re-exports CommandProperties
Re-exports CommandRegistryExt
Re-exports CommandRegistryMain
Re-exports CommentProviderFeatures
Re-exports CommentRule
Re-exports CommentThreadChanges
Re-exports CommentsCommandArg
Re-exports CommentsContextCommandArg
Re-exports CommentsEditCommandArg
Re-exports CommentsExt
Re-exports CommentsMain
Re-exports ConfigStorage
Re-exports ConnectionExt
Re-exports ConnectionMain
Re-exports ContentDecorationRenderOptions
Re-exports CustomEditor
Re-exports CustomEditorPriority
Re-exports CustomEditorSelector
Re-exports CustomEditorsExt
Re-exports CustomEditorsMain
Re-exports CustomInputDto
Re-exports CustomTextEditorCapabilities
Re-exports DataTransferFileDTO
Re-exports DebugConfigurationProvider
Re-exports DebugConfigurationProviderDescriptor
Re-exports DebugConfigurationProviderTriggerKind
Re-exports DebugExt
Re-exports DebugMain
Re-exports DebuggerContribution
Re-exports DecorationData
Re-exports DecorationInstanceRenderOptions
Re-exports DecorationOptions
Re-exports DecorationRenderOptions
Re-exports DecorationReply
Re-exports DecorationRequest
Re-exports DecorationsExt
Re-exports DecorationsMain
Re-exports DeployedPlugin
Re-exports DialogsMain
Re-exports DocumentsExt
Re-exports DocumentsMain
Re-exports EditorChangedPropertiesData
Re-exports EditorGroupColumn
Re-exports EditorPosition
Re-exports EditorsAndDocumentsDelta
Re-exports EditorsAndDocumentsExt
Re-exports EnterAction
Re-exports EnvInit
Re-exports EnvMain
Re-exports ExtHostFileSystemEventServiceShape
Re-exports ExtPluginApi
Re-exports ExtPluginApiBackendInitializationFn
Re-exports ExtPluginApiFrontendInitializationFn
Re-exports ExtPluginApiProvider
Re-exports ExtensionContext
Re-exports FileSystemEvents
Re-exports FileSystemExt
Re-exports FileSystemMain
Re-exports FileUploadResultMain
Re-exports FoldingMarkers
Re-exports FoldingRules
Re-exports FrontendExtPluginApi
Re-exports GetDeployedPluginsParams
Re-exports GlobalStorageKind
Re-exports GrammarsContribution
Re-exports HostedPluginClient
Re-exports HostedPluginServer
Re-exports IFileChangeDto
Re-exports IInputBoxOptions
Re-exports IconThemeContribution
Re-exports IconUrl
Re-exports IdentifiableInlineCompletion
Re-exports IdentifiableInlineCompletions
Re-exports IndentationRules
Re-exports InlayHintDto
Re-exports InlayHintsDto
Re-exports InteractiveEditorInputDto
Re-exports Item
Re-exports Keybinding
Re-exports LabelServiceExt
Re-exports LabelServiceMain
Re-exports LanguageConfiguration
Re-exports LanguageContribution
Re-exports LanguageStatus
Re-exports LanguagesExt
Re-exports LanguagesMain
Re-exports LanguagesMainFactory
Re-exports Localization
Re-exports LocalizationExt
Re-exports LocalizationMain
Re-exports MAIN_RPC_CONTEXT
Re-exports MainMessageItem
Re-exports MainMessageOptions
Re-exports MainMessageType
Re-exports MainPluginApiProvider
Re-exports Menu
Re-exports MessageRegistryMain
Re-exports MetadataProcessor
Re-exports ModelAddedData
Re-exports ModelChangedEvent
Re-exports ModelContentChange
Re-exports NotebookContribution
Re-exports NotebookDiffInputDto
Re-exports NotebookInputDto
Re-exports NotificationExt
Re-exports NotificationMain
Re-exports OnEnterRule
Re-exports OpenDialogOptionsMain
Re-exports OutputChannelRegistryExt
Re-exports OutputChannelRegistryFactory
Re-exports OutputChannelRegistryMain
Re-exports PLUGIN_HOST_BACKEND
Re-exports PLUGIN_RPC_CONTEXT
Re-exports PlatformSpecificAdapterContribution
Re-exports Plugin
Re-exports PluginAPI
Re-exports PluginAPIFactory
Re-exports PluginColorContribution
Re-exports PluginCommand
Re-exports PluginContext
Re-exports PluginContribution
Re-exports PluginDependencies
Re-exports PluginDeployOptions
Re-exports PluginDeployer
Re-exports PluginDeployerDirectoryHandler
Re-exports PluginDeployerDirectoryHandlerContext
Re-exports PluginDeployerEntry
Re-exports PluginDeployerEntryType
Re-exports PluginDeployerFileHandler
Re-exports PluginDeployerFileHandlerContext
Re-exports PluginDeployerHandler
Re-exports PluginDeployerParticipant
Re-exports PluginDeployerResolver
Re-exports PluginDeployerResolverContext
Re-exports PluginDeployerResolverInit
Re-exports PluginDeployerStartContext
Re-exports PluginEngine
Re-exports PluginEntryPoint
Re-exports PluginHostEnvironmentVariable
Re-exports PluginIconThemeContribution
Re-exports PluginIdentifiers
Re-exports PluginIdentifiers
Re-exports PluginInfo
Re-exports PluginJsonValidationContribution
Re-exports PluginLifecycle
Re-exports PluginManager
Re-exports PluginManagerExt
Re-exports PluginManagerInitializeParams
Re-exports PluginManagerStartParams
Re-exports PluginMetadata
Re-exports PluginModel
Re-exports PluginPackage
Re-exports PluginPackageAuthenticationProvider
Re-exports PluginPackageCommand
Re-exports PluginPackageContribution
Re-exports PluginPackageCustomEditor
Re-exports PluginPackageDebuggersContribution
Re-exports PluginPackageGrammarsContribution
Re-exports PluginPackageKeybinding
Re-exports PluginPackageLanguageContribution
Re-exports PluginPackageLanguageContributionConfiguration
Re-exports PluginPackageLocalization
Re-exports PluginPackageMenu
Re-exports PluginPackageNotebook
Re-exports PluginPackageSnippetsContribution
Re-exports PluginPackageSubmenu
Re-exports PluginPackageTerminal
Re-exports PluginPackageTerminalProfile
Re-exports PluginPackageTranslation
Re-exports PluginPackageView
Re-exports PluginPackageViewContainer
Re-exports PluginPackageViewWelcome
Re-exports PluginProblemMatcherContribution
Re-exports PluginProblemPatternContribution
Re-exports PluginScanner
Re-exports PluginServer
Re-exports PluginStorageKind
Re-exports PluginTaskDefinitionContribution
Re-exports PluginThemeContribution
Re-exports PluginType
Re-exports PluginUiTheme
Re-exports PluginViewType
Re-exports Position
Re-exports PreferenceChangeExt
Re-exports PreferenceData
Re-exports PreferenceRegistryExt
Re-exports PreferenceRegistryMain
Re-exports ProcessTaskDto
Re-exports QuickOpenExt
Re-exports QuickOpenMain
Re-exports RawColorInfo
Re-exports RegExpOptions
Re-exports RegisterTreeDataProviderOptions
Re-exports RunOptionsDTO
Re-exports SaveDialogOptionsMain
Re-exports ScmCommandArg
Re-exports ScmExt
Re-exports ScmMain
Re-exports ScmRawResource
Re-exports ScmRawResourceGroup
Re-exports ScmRawResourceSplice
Re-exports ScmRawResourceSplices
Re-exports ScopeMap
Re-exports SecretsExt
Re-exports SecretsMain
Re-exports Selection
Re-exports SelectionChangeEvent
Re-exports SerializedEnterAction
Re-exports SerializedIndentationRule
Re-exports SerializedLanguageConfiguration
Re-exports SerializedOnEnterRule
Re-exports SerializedRegExp
Re-exports ServerPluginRunner
Re-exports SingleEditOperation
Re-exports SnippetContribution
Re-exports SourceControlGroupFeatures
Re-exports SourceControlProviderFeatures
Re-exports SourceControlResourceDecorations
Re-exports SourceControlResourceState
Re-exports StatusBarMessageRegistryMain
Re-exports StorageExt
Re-exports StorageMain
Re-exports StringDetails
Re-exports Submenu
Re-exports TabDto
Re-exports TabGroupDto
Re-exports TabInputDto
Re-exports TabInputKind
Re-exports TabModelOperationKind
Re-exports TabOperation
Re-exports TabsExt
Re-exports TabsMain
Re-exports TaskDto
Re-exports TaskExecutionDto
Re-exports TaskGroupKind
Re-exports TaskPresentationOptionsDTO
Re-exports TasksExt
Re-exports TasksMain
Re-exports TelemetryExt
Re-exports TelemetryMain
Re-exports TerminalOptionsExt
Re-exports TerminalProfile
Re-exports TerminalServiceExt
Re-exports TerminalServiceMain
Re-exports TextDiffInputDto
Re-exports TextEditorAddData
Re-exports TextEditorConfiguration
Re-exports TextEditorConfigurationUpdate
Re-exports TextEditorPositionData
Re-exports TextEditorRevealType
Re-exports TextEditorsExt
Re-exports TextEditorsMain
Re-exports TextInputDto
Re-exports TextMergeInputDto
Re-exports ThemeColor
Re-exports ThemeContribution
Re-exports ThemeDecorationInstanceRenderOptions
Re-exports ThemeDecorationRenderOptions
Re-exports ThemeIcon
Re-exports ThemingExt
Re-exports ThemingMain
Re-exports TimelineCommandArg
Re-exports TimelineExt
Re-exports TimelineMain
Re-exports TrackedRangeStickiness
Re-exports TransferInputBox
Re-exports TransferQuickInput
Re-exports TransferQuickInputButton
Re-exports TransferQuickPick
Re-exports TransferQuickPickItemValue
Re-exports TransferQuickPickItems
Re-exports TransferQuickPickSeparator
Re-exports Translation
Re-exports TreeViewItem
Re-exports TreeViewItemCollapsibleState
Re-exports TreeViewItemReference
Re-exports TreeViewRevealOptions
Re-exports TreeViewsExt
Re-exports TreeViewsMain
Re-exports UIKind
Re-exports UiTheme
Re-exports UndoStopOptions
Re-exports UnknownInputDto
Re-exports UnresolvedPluginEntry
Re-exports UploadDialogOptionsMain
Re-exports View
Re-exports ViewContainer
Re-exports ViewWelcome
Re-exports WebviewInitData
Re-exports WebviewInputDto
Re-exports WebviewPanelViewState
Re-exports WebviewViewsExt
Re-exports WebviewViewsMain
Re-exports WebviewsExt
Re-exports WebviewsMain
Re-exports WindowMain
Re-exports WindowStateExt
Re-exports WorkspaceEditDto
Re-exports WorkspaceEditEntryMetadataDto
Re-exports WorkspaceEditMetadataDto
Re-exports WorkspaceExt
Re-exports WorkspaceFileEditDto
Re-exports WorkspaceFolderPickOptionsMain
Re-exports WorkspaceMain
Re-exports WorkspaceStorageKind
Re-exports WorkspaceTextEditDto
Re-exports buildFrontendModuleName
Re-exports default
Re-exports default
Re-exports emptyPlugin
Re-exports getPluginId
Re-exports hostedServicePath
Re-exports pluginServerJsonRpcPath

Type Aliases

ArgumentAdapter: ((...args: unknown[]) => unknown[])

Type declaration

    • (...args: unknown[]): unknown[]
    • Parameters

      • Rest ...args: unknown[]

      Returns unknown[]

CacheId: number
CachedSession<T>: T & { cacheId?: CacheId }

Type Parameters

  • T

CachedSessionItem<T>: T & { cacheId?: ChainedCacheId }

Type Parameters

  • T

ChainedCacheId: [CacheId, CacheId]
CharacterPair: [string, string]
CodeActionProviderDocumentation: ReadonlyArray<{ command: Command; kind: string }>
CommentThreadChanges: Partial<{ canReply: boolean; collapseState: CommentThreadCollapsibleState; comments: Comment[]; contextValue: string; label: string; range: Range; state: CommentThreadState }>
ContributionPoint: typeof implementedVSCodeContributionPoints[number]
DebugActivationEvent: "onDebugResolve" | "onDebugInitialConfigurations" | "onDebugAdapterProtocolTracker" | "onDebugDynamicConfigurations"
DecorationData: [boolean, string, string, ThemeColor]
Definition: Location | Location[] | LocationLink[]
Definition: Location | Location[]
Edge: [State, number, State]
EditorGroupColumn: number
GlobalStorageKind: undefined
Handler: (<T>(...args: any[]) => T | PromiseLike<T | undefined>)

Type declaration

    • <T>(...args: any[]): T | PromiseLike<T | undefined>
    • Type Parameters

      • T

      Parameters

      • Rest ...args: any[]

      Returns T | PromiseLike<T | undefined>

IconUrl: string | { dark: string; light: string }
InlayHintsDto: CachedSession<{ hints: InlayHint[] }>
Item: string | theia.QuickPickItem
MacAddresCallback: ((err: any, data: any) => void)

Type declaration

    • (err: any, data: any): void
    • Parameters

      • err: any
      • data: any

      Returns void

MacAddressOneCallback: ((err: any, mac: string) => void)

Type declaration

    • (err: any, mac: string): void
    • Parameters

      • err: any
      • mac: string

      Returns void

PluginEngine: string

Plugin engine (API) type, i.e. 'theiaPlugin', 'vscode', etc.

PluginHost: "frontend" | string
PluginIconPath: string | URI | { dark: string | URI; light: string | URI }
PluginIconThemeFactory: ((definition: PluginIconThemeDefinition) => PluginIconTheme)

Type declaration

PluginUiTheme: "vs" | "vs-dark" | "hc-black"
TaskGroupKind: "build" | "test" | "rebuild" | "clean"
TransferQuickInput: TransferQuickPick | TransferInputBox
UiTheme: "vs" | "vs-dark" | "hc-black"
ViewDataProvider: ((params: { state?: object; viewInfo: View }) => Promise<TreeViewWidget>)

Type declaration

WebviewPreferences: PreferenceProxy<WebviewConfiguration>
WebviewThemeType: "vscode-light" | "vscode-dark" | "vscode-high-contrast"

Variables

ALL_ACTIVATION_EVENT: "*" = '*'
COMMENT_CONTEXT: MenuPath = ...
COMMENT_THREAD_CONTEXT: MenuPath = ...
COMMENT_TITLE: MenuPath = ...
CommentsService: typeof CommentsService = ...
DEFAULT_WORD_REGEXP: RegExp = ...
ExtPluginApiProvider: "extPluginApi" = 'extPluginApi'
HostedPluginClient: typeof HostedPluginClient = ...
HostedPluginProcessConfiguration: typeof HostedPluginProcessConfiguration = ...
HostedPluginServer: typeof HostedPluginServer = ...
LanguagePackService: typeof LanguagePackService = ...
LanguagesMainFactory: typeof LanguagesMainFactory = ...
MAIN_RPC_CONTEXT: { AUTHENTICATION_EXT: ProxyIdentifier<AuthenticationExt>; COMMAND_REGISTRY_EXT: ProxyIdentifier<CommandRegistryExt>; COMMENTS_EXT: ProxyIdentifier<CommentsExt>; CONNECTION_EXT: ProxyIdentifier<ConnectionExt>; CUSTOM_EDITORS_EXT: ProxyIdentifier<CustomEditorsExt>; DEBUG_EXT: ProxyIdentifier<DebugExt>; DECORATIONS_EXT: ProxyIdentifier<DecorationsExt>; DOCUMENTS_EXT: ProxyIdentifier<DocumentsExt>; EDITORS_AND_DOCUMENTS_EXT: ProxyIdentifier<EditorsAndDocumentsExt>; ExtHostFileSystemEventService: ProxyIdentifier<ExtHostFileSystemEventServiceShape>; FILE_SYSTEM_EXT: ProxyIdentifier<FileSystemExt>; HOSTED_PLUGIN_MANAGER_EXT: ProxyIdentifier<PluginManagerExt>; LABEL_SERVICE_EXT: ProxyIdentifier<LabelServiceExt>; LANGUAGES_EXT: ProxyIdentifier<LanguagesExt>; NOTIFICATION_EXT: ProxyIdentifier<NotificationExt>; OUTPUT_CHANNEL_REGISTRY_EXT: ProxyIdentifier<OutputChannelRegistryExt>; PREFERENCE_REGISTRY_EXT: ProxyIdentifier<PreferenceRegistryExt>; QUICK_OPEN_EXT: ProxyIdentifier<QuickOpenExt>; SCM_EXT: ProxyIdentifier<ScmExt>; SECRETS_EXT: ProxyIdentifier<SecretsExt>; STORAGE_EXT: ProxyIdentifier<StorageExt>; TABS_EXT: ProxyIdentifier<TabsExt>; TASKS_EXT: ProxyIdentifier<TasksExt>; TELEMETRY_EXT: ProxyIdentifier<TelemetryExt>; TERMINAL_EXT: ProxyIdentifier<TerminalServiceExt>; TEXT_EDITORS_EXT: ProxyIdentifier<TextEditorsExt>; THEMING_EXT: ProxyIdentifier<ThemingExt>; TIMELINE_EXT: ProxyIdentifier<TimelineExt>; TREE_VIEWS_EXT: ProxyIdentifier<TreeViewsExt>; WEBVIEWS_EXT: ProxyIdentifier<WebviewsExt>; WEBVIEW_VIEWS_EXT: ProxyIdentifier<WebviewViewsExt>; WINDOW_STATE_EXT: ProxyIdentifier<WindowStateExt>; WORKSPACE_EXT: ProxyIdentifier<WorkspaceExt> } = ...

Type declaration

MainPluginApiProvider: typeof MainPluginApiProvider = ...
MetadataProcessor: typeof MetadataProcessor = ...
OutputChannelRegistryFactory: typeof OutputChannelRegistryFactory = ...
PLUGINS_LABEL: string = ...
PLUGIN_EDITOR_TITLE_MENU: string[] = ...
PLUGIN_HOST_BACKEND: "main" = 'main'
PLUGIN_RPC_CONTEXT: { AUTHENTICATION_MAIN: ProxyIdentifier<AuthenticationMain>; CLIPBOARD_MAIN: ProxyIdentifier<ClipboardMain>; COMMAND_REGISTRY_MAIN: ProxyIdentifier<CommandRegistryMain>; COMMENTS_MAIN: ProxyIdentifier<CommentsMain>; CONNECTION_MAIN: ProxyIdentifier<ConnectionMain>; CUSTOM_EDITORS_MAIN: ProxyIdentifier<CustomEditorsMain>; DEBUG_MAIN: ProxyIdentifier<DebugMain>; DECORATIONS_MAIN: ProxyIdentifier<DecorationsMain>; DIALOGS_MAIN: ProxyIdentifier<DialogsMain>; DOCUMENTS_MAIN: ProxyIdentifier<DocumentsMain>; ENV_MAIN: ProxyIdentifier<EnvMain>; FILE_SYSTEM_MAIN: ProxyIdentifier<FileSystemMain>; LABEL_SERVICE_MAIN: ProxyIdentifier<LabelServiceMain>; LANGUAGES_MAIN: ProxyIdentifier<LanguagesMain>; LOCALIZATION_MAIN: ProxyIdentifier<LocalizationMain>; MESSAGE_REGISTRY_MAIN: ProxyIdentifier<MessageRegistryMain>; NOTIFICATION_MAIN: ProxyIdentifier<NotificationMain>; OUTPUT_CHANNEL_REGISTRY_MAIN: ProxyIdentifier<OutputChannelRegistryMain>; PREFERENCE_REGISTRY_MAIN: ProxyIdentifier<PreferenceRegistryMain>; QUICK_OPEN_MAIN: ProxyIdentifier<QuickOpenMain>; SCM_MAIN: ProxyIdentifier<ScmMain>; SECRETS_MAIN: ProxyIdentifier<SecretsMain>; STATUS_BAR_MESSAGE_REGISTRY_MAIN: ProxyIdentifier<StatusBarMessageRegistryMain>; STORAGE_MAIN: ProxyIdentifier<StorageMain>; TABS_MAIN: ProxyIdentifier<TabsMain>; TASKS_MAIN: ProxyIdentifier<TasksMain>; TELEMETRY_MAIN: ProxyIdentifier<TelemetryMain>; TERMINAL_MAIN: ProxyIdentifier<TerminalServiceMain>; TEXT_EDITORS_MAIN: ProxyIdentifier<TextEditorsMain>; THEMING_MAIN: ProxyIdentifier<ThemingMain>; TIMELINE_MAIN: ProxyIdentifier<TimelineMain>; TREE_VIEWS_MAIN: ProxyIdentifier<TreeViewsMain>; WEBVIEWS_MAIN: ProxyIdentifier<WebviewsMain>; WEBVIEW_VIEWS_MAIN: ProxyIdentifier<WebviewViewsMain>; WINDOW_MAIN: ProxyIdentifier<WindowMain>; WORKSPACE_MAIN: ProxyIdentifier<WorkspaceMain> } = ...

Type declaration

PLUGIN_SCM_TITLE_MENU: string[] = ...
PLUGIN_VIEW_CONTAINER_FACTORY_ID: "plugin-view-container" = 'plugin-view-container'
PLUGIN_VIEW_DATA_FACTORY_ID: "plugin-view-data" = 'plugin-view-data'
PLUGIN_VIEW_FACTORY_ID: "plugin-view" = 'plugin-view'
PLUGIN_VIEW_TITLE_MENU: string[] = ...
PluginDeployer: typeof PluginDeployer = ...
PluginDeployerDirectoryHandler: typeof PluginDeployerDirectoryHandler = ...
PluginDeployerFileHandler: typeof PluginDeployerFileHandler = ...
PluginDeployerHandler: typeof PluginDeployerHandler = ...
PluginDeployerParticipant: typeof PluginDeployerParticipant = ...
PluginDeployerResolver: typeof PluginDeployerResolver = ...

A plugin resolver is handling how to resolve a plugin link into a local resource.

PluginHostEnvironmentVariable: typeof PluginHostEnvironmentVariable = ...
PluginIconThemeFactory: typeof PluginIconThemeFactory = ...
PluginPathsService: typeof PluginPathsService = ...
PluginProgressLocation: "plugin" = 'plugin'
PluginScanner: typeof PluginScanner = ...
PluginServer: typeof PluginServer = ...
PluginUriFactory: typeof PluginUriFactory = ...
RPCProtocol: typeof RPCProtocol = ...
ServerPluginRunner: typeof ServerPluginRunner = ...
TREE_NODE_HYPERLINK: "theia-TreeNodeHyperlink" = 'theia-TreeNodeHyperlink'
TreeViewDecorator: typeof TreeViewDecorator = ...
USUAL_WORD_SEPARATORS: "`~!@#$%^&*()-=+[{]}\\|;:'\",.<>/?" = '`~!@#$%^&*()-=+[{]}\\|;:\'",.<>/?'
VIEW_ITEM_CONTEXT_MENU: MenuPath = ...
VIEW_ITEM_INLINE_MENU: MenuPath = ...
WebviewConfigSchema: PreferenceSchema = ...
WebviewPreferenceContribution: typeof WebviewPreferenceContribution = ...
WebviewPreferences: typeof WebviewPreferences = ...
WebviewWidgetExternalEndpoint: typeof WebviewWidgetExternalEndpoint = ...
codeToTheiaMappings: Map<"comments/comment/context" | "comments/comment/title" | "comments/commentThread/context" | "debug/callstack/context" | "debug/variables/context" | "debug/toolBar" | "editor/context" | "editor/title" | "editor/title/context" | "explorer/context" | "scm/resourceFolder/context" | "scm/resourceGroup/context" | "scm/resourceState/context" | "scm/title" | "timeline/item/context" | "view/item/context" | "view/title", MenuPath[]> = ...

The values are menu paths to which the VSCode contribution points correspond

default: ContainerModule
default: ContainerModule
default: ContainerModule
default: ContainerModule
emptyPlugin: Plugin = ...
hostedServicePath: "/services/hostedPlugin" = '/services/hostedPlugin'
implementedVSCodeContributionPoints: readonly ["comments/comment/context", "comments/comment/title", "comments/commentThread/context", "debug/callstack/context", "debug/variables/context", "debug/toolBar", "editor/context", "editor/title", "editor/title/context", "explorer/context", "scm/resourceFolder/context", "scm/resourceGroup/context", "scm/resourceState/context", "scm/title", "timeline/item/context", "view/item/context", "view/title"] = ...
languagePackServicePath: "/services/languagePackService" = '/services/languagePackService'
pluginPathsServicePath: "/services/plugin-paths" = '/services/plugin-paths'
pluginServerJsonRpcPath: "/services/plugin-ext" = '/services/plugin-ext'

The JSON-RPC workspace interface.

testItemCollection: { add: (() => void); delete: (() => void); forEach: (() => void); get: (() => undefined); replace: (() => void); size: number; [iterator]: any } = ...

Type declaration

  • add: (() => void)
      • (): void
      • Returns void

  • delete: (() => void)
      • (): void
      • Returns void

  • forEach: (() => void)
      • (): void
      • Returns void

  • get: (() => undefined)
      • (): undefined
      • Returns undefined

  • replace: (() => void)
      • (): void
      • Returns void

  • size: number
  • [iterator]:function
    • [iterator](): Generator<never, void, unknown>

Functions

  • assertIsDefined<T>(arg: undefined | null | T): T
  • bindCommonHostedBackend(bind: Bind): void
  • bindElectronBackend(bind: Bind): void
  • bindHostedBackend(bind: Bind): void
  • bindMainBackend(bind: Bind, unbind: Unbind, isBound: IsBound, rebind: Rebind): void
  • bindTreeViewDecoratorUtilities(bind: Bind): void
  • bindWebviewPreferences(bind: Bind): void
  • cleanData(data: Record<string, any>, cleanUpPatterns: RegExp[]): Record<string, any>
  • Does a best possible effort to clean a data object from any possible PII.

    Parameters

    • data: Record<string, any>

      The data object to clean

    • cleanUpPatterns: RegExp[]

    Returns Record<string, any>

    A new object with the PII removed

  • cloneAndChange(obj: any, changer: ((orig: any) => any)): any
  • coalesce<T>(array: readonly (undefined | null | T)[]): T[]
  • convertCode(code: undefined | string | number | { target: Uri; value: string | number }): string | undefined
  • convertDiagnosticToMarkerData(diagnostic: Diagnostic): MarkerData
  • createRunProfile(label: string, kind: TestRunProfileKind, runHandler: ((request: TestRunRequest, token: CancellationToken) => void | Thenable<void>), isDefault?: boolean, tag?: TestTag, supportsContinuousRun?: boolean): { configureHandler: undefined; dispose: (() => undefined); isDefault: boolean; kind: TestRunProfileKind; label: string; runHandler: ((request: TestRunRequest, token: CancellationToken) => void | Thenable<void>); supportsContinuousRun: boolean; tag: undefined | TestTag }
  • Parameters

    • label: string
    • kind: TestRunProfileKind
    • runHandler: ((request: TestRunRequest, token: CancellationToken) => void | Thenable<void>)
        • (request: TestRunRequest, token: CancellationToken): void | Thenable<void>
        • Parameters

          • request: TestRunRequest
          • token: CancellationToken

          Returns void | Thenable<void>

    • Optional isDefault: boolean
    • Optional tag: TestTag
    • Optional supportsContinuousRun: boolean

    Returns { configureHandler: undefined; dispose: (() => undefined); isDefault: boolean; kind: TestRunProfileKind; label: string; runHandler: ((request: TestRunRequest, token: CancellationToken) => void | Thenable<void>); supportsContinuousRun: boolean; tag: undefined | TestTag }

    • configureHandler: undefined
    • dispose: (() => undefined)
        • (): undefined
        • Returns undefined

    • isDefault: boolean
    • kind: TestRunProfileKind
    • label: string
    • runHandler: ((request: TestRunRequest, token: CancellationToken) => void | Thenable<void>)
        • (request: TestRunRequest, token: CancellationToken): void | Thenable<void>
        • Parameters

          • request: TestRunRequest
          • token: CancellationToken

          Returns void | Thenable<void>

    • supportsContinuousRun: boolean
    • tag: undefined | TestTag
  • createTestItem(id: string, label: string, uri?: Uri): TestItem
  • createTestRun(request: TestRunRequest, name?: string, persist?: boolean): TestRun
  • createWebviewPreferences(preferences: PreferenceService, schema?: PreferenceSchema): WebviewPreferences
  • cursorStyleToString(cursorStyle: TextEditorCursorStyle): "line" | "block" | "underline" | "line-thin" | "block-outline" | "underline-thin"
  • diffSets<T>(before: Set<T>, after: Set<T>): { added: T[]; removed: T[] }
  • dispose<T>(disposable: T): T | undefined
  • dispose<T>(...disposables: T[]): T[] | undefined
  • dispose<T>(disposables: T[]): T[] | undefined
  • disposed(what: string): Error
  • ensureValidWordDefinition(wordDefinition?: RegExp): RegExp
  • es5ClassCompat<T>(target: T): T
  • flatten<T>(arr: T[][]): T[]
  • fromColor(color: Color): [number, number, number, number]
  • fromDefinitionLink(definitionLink: LocationLink): LocationLink
  • fromDocumentSelector(selector: undefined | DocumentSelector): LanguageSelector | undefined
  • fromFoldingRangeKind(kind: undefined | FoldingRangeKind): FoldingRangeKind | undefined
  • fromGlobPattern(pattern: GlobPattern): string | RelativePattern
  • fromHover(hover: Hover): Hover
  • fromItemHierarchyDefinition(definition: TypeHierarchyItem | CallHierarchyItem): HierarchyItem
  • fromLocation(location: Location): Location
  • fromLocation(location: Location): Location
  • fromManyMarkdown(markup: (MarkdownString | MarkedString)[]): MarkdownStringDTO[]
  • fromMarkdown(markup: MarkdownString | MarkedString): MarkdownStringDTO
  • fromPosition(position: Position): Position
  • fromProcessExecution(execution: ProcessExecution, taskDto: TaskDto): TaskDto
  • fromRange(range: Range): Range
  • fromRange(range: undefined): undefined
  • fromRange(range: Range): Range
  • fromRange(range: undefined | Range): Range | undefined
  • fromRangeOrRangeWithMessage(ranges: DecorationOptions[] | Range[]): DecorationOptions[]
  • fromShellExecution(execution: ShellExecution, taskDto: TaskDto): TaskDto
  • fromSymbolInformation(symbolInformation: SymbolInformation): lstypes.SymbolInformation | undefined
  • fromTask(task: Task): TaskDto | undefined
  • fromUriComponents(uri: UriComponents): string
  • fromViewColumn(column?: ViewColumn): number
  • getAuthenticationProviderActivationEvent(id: string): string
  • getAuthenticationProviderActivationEvent(id: string): string
  • getCustomExecution(taskDto: TaskDto): theia.CustomExecution
  • getDarkIconUri(iconPath: URI | { dark: URI; light: URI }): URI
  • getIconClass(options: TerminalOptions | ExtensionTerminalOptions): string | undefined
  • getIconPathOrClass(button: QuickInputButton): { iconClass: string | undefined; iconPath: { dark: URI; light?: URI } | undefined }
  • Parameters

    • button: QuickInputButton

    Returns { iconClass: string | undefined; iconPath: { dark: URI; light?: URI } | undefined }

    • iconClass: string | undefined
    • iconPath: { dark: URI; light?: URI } | undefined
  • getIconUris(iconPath: Uri | { dark: Uri; light: Uri } | ThemeIcon): { dark: URI; light: URI } | { id: string }
  • getIconUris(iconPath: undefined | ThemeIcon): { id: string } | undefined
  • getLightIconUri(iconPath: URI | { dark: URI; light: URI }): URI
  • getPreferences(preferenceProviderProvider: PreferenceProviderProvider, rootFolders: FileStat[]): PreferenceData
  • getProcessExecution(taskDto: TaskDto): theia.ProcessExecution
  • getShellArgs(args: undefined | (string | ShellQuotedString)[]): string[]
  • getShellExecution(taskDto: TaskDto): theia.ShellExecution
  • getShellExecutionOptions(options: ShellExecutionOptions): {}
  • getTempDir(name: string): string
  • getWordAtText(column: number, wordDefinition: RegExp, text: string, textOffset: number): WordAtPosition | undefined
  • getWordDefinitionFor(modeId: string): RegExp
  • illegalArgument(message?: string): Error
  • isArray(array: any): array is any[]
  • isDecorationOptionsArr(something: DecorationOptions[] | Range[]): something is DecorationOptions[]
  • isDefinitionLinkArray(array: unknown): array is LocationLink[]
  • isLocationArray(array: unknown): array is Location[]
  • isModelLocation(arg: unknown): arg is Location
  • isModelRange(arg: unknown): arg is Range
  • isNonEmptyArray<T>(obj: undefined | null | T[]): obj is T[]
  • isNonEmptyArray<T>(obj: undefined | null | readonly T[]): obj is readonly T[]
  • isObject(obj: unknown): boolean
  • isPromiseCanceledError(error: any): boolean
  • isReadonlyArray(arg: unknown): arg is readonly unknown[]
  • isUndefined(obj: any): obj is undefined
  • isUndefinedOrNull(obj: any): obj is undefined | null
  • isUriComponents(arg: unknown): arg is UriComponents
  • join(...paths: string[]): string
  • mixin(destination: any, source: any, overwrite?: boolean): any
  • networkInterfaces(): any
  • normalize(p: string): string
  • normalize(path: string): string
  • ok(val?: any, message?: string): void
  • once<T>(this: unknown, fn: T): T
  • pathOrURIToURI(value: string | URI): URI
  • readonly(name?: string): Error
  • regExpLeadsToEndlessLoop(regexp: RegExp): boolean
  • registerMsgPackExtensions(): void
  • relative(from: string, to: string): string
  • resolve(...paths: string[]): string
  • setUpPluginApi(rpc: RPCProtocol, container: Container): void
  • setWordDefinitionFor(modeId: string, wordDefinition: null | RegExp): void
  • theiaUritoUriComponents(uri: URI): UriComponents
  • toColor(color: [number, number, number, number]): Color
  • toItemHierarchyDefinition(modelItem: HierarchyItem): TypeHierarchyItem | CallHierarchyItem
  • toLocation(uri: UriComponents, range: Range): languageProtocol.Location
  • toMonacoWorkspaceEdit(data: undefined | WorkspaceEditDto): monaco.languages.WorkspaceEdit
  • toRange(range: Range): languageProtocol.Range
  • toSymbolInformation(symbolInformation: SymbolInformation): theia.SymbolInformation | undefined
  • toTask(taskDto: TaskDto): theia.Task
  • toUint32(v: number): number
  • toUint8(v: number): number
  • toUriComponents(uri: string): UriComponents
  • toWebviewPanelShowOptions(options: ViewColumn | WebviewPanelShowOptions): theia.WebviewPanelShowOptions