terminal | Theia TypeDoc

Index

References

Namespaces

Enumerations

Type Aliases

Functions

References

TerminalContribution

Re-exports TerminalContribution

bindTerminalServer

Re-exports bindTerminalServer

Type Aliases

ConfirmOnExitType

ConfirmOnExitType: "never" | "always" | "hasChildProcesses"

CursorStyle

CursorStyle: "block" | "underline" | "bar"

CursorStyleVSCode

CursorStyleVSCode: CursorStyle | "line"

Profiles

Profiles: null | {}

SerializableEnvironmentVariableCollection

SerializableEnvironmentVariableCollection: [string, EnvironmentVariableMutator][]

ShellProcessFactory

ShellProcessFactory: ((options: ShellProcessOptions) => ShellProcess)

Type declaration

- (options: ShellProcessOptions): ShellProcess
- Parameters
  - options: ShellProcessOptions
  Returns ShellProcess

ShellTerminalOSPreferences

ShellTerminalOSPreferences<T>: { [ key in OS.Type]: T }

Type Parameters

ShellTerminalServerProxy

ShellTerminalServerProxy: JsonRpcProxy<IShellTerminalServer>

TerminalLocationOptions

TerminalLocationOptions: TerminalLocation | TerminalEditorLocation | TerminalSplitLocation

TerminalPreferences

TerminalPreferences: PreferenceProxy<TerminalConfiguration>

TerminalRendererType

TerminalRendererType: "canvas" | "dom"

TerminalSearchWidgetFactory

TerminalSearchWidgetFactory: ((terminal: Terminal) => TerminalSearchWidget)

Type declaration

- (terminal: Terminal): TerminalSearchWidget
- Parameters
  - terminal: Terminal
  Returns TerminalSearchWidget

XtermLinkFactory

XtermLinkFactory: ((link: TerminalLink, terminal: TerminalWidgetImpl, context: LinkContext) => ILink)

Type declaration

- (link: TerminalLink, terminal: TerminalWidgetImpl, context: LinkContext): ILink
- Parameters
  - link: TerminalLink
  - terminal: TerminalWidgetImpl
  - context: LinkContext
  Returns ILink

Variables

Const ContributedTerminalProfileStore

ContributedTerminalProfileStore: typeof ContributedTerminalProfileStore = ...

Const DEFAULT_TERMINAL_RENDERER_TYPE

DEFAULT_TERMINAL_RENDERER_TYPE: "canvas" = 'canvas'

Const ENVIRONMENT_VARIABLE_COLLECTIONS_KEY

ENVIRONMENT_VARIABLE_COLLECTIONS_KEY: "terminal.integrated.environmentVariableCollections" = 'terminal.integrated.environmentVariableCollections'

Const IShellTerminalServer

IShellTerminalServer: typeof IShellTerminalServer = ...

Const ITerminalServer

ITerminalServer: typeof ITerminalServer = ...

Const LinkContext

LinkContext: typeof LinkContext = ...

Const NULL_PROFILE

NULL_PROFILE: TerminalProfile = ...

Const ShellProcessFactory

ShellProcessFactory: typeof ShellProcessFactory = ...

Const ShellProcessOptions

ShellProcessOptions: typeof ShellProcessOptions = ...

Const ShellTerminalServerProxy

ShellTerminalServerProxy: typeof ShellTerminalServerProxy = ...

Const TERMINAL_SEARCH_WIDGET_FACTORY_ID

TERMINAL_SEARCH_WIDGET_FACTORY_ID: "terminal-search" = 'terminal-search'

Const TERMINAL_WIDGET_FACTORY_ID

TERMINAL_WIDGET_FACTORY_ID: "terminal" = 'terminal'

Const TerminalConfigSchema

TerminalConfigSchema: PreferenceSchema = ...

Const TerminalContribution

TerminalContribution: typeof TerminalContribution = ...

Const TerminalLink

TerminalLink: typeof TerminalLink = ...

Const TerminalLinkProvider

TerminalLinkProvider: typeof TerminalLinkProvider = ...

Const TerminalPreferenceContribution

TerminalPreferenceContribution: typeof TerminalPreferenceContribution = ...

Const TerminalPreferences

TerminalPreferences: typeof TerminalPreferences = ...

Const TerminalProfileService

TerminalProfileService: typeof TerminalProfileService = ...

Const TerminalSearchWidgetFactory

TerminalSearchWidgetFactory: typeof TerminalSearchWidgetFactory = ...

Const TerminalService

TerminalService: typeof TerminalService = ...

Service manipulating terminal widgets.

Const TerminalWidgetOptions

TerminalWidgetOptions: typeof TerminalWidgetOptions = ...

Terminal widget options.

Const UserTerminalProfileStore

UserTerminalProfileStore: typeof UserTerminalProfileStore = ...

Const XtermLink

XtermLink: typeof XtermLink = ...

Const XtermLinkFactory

XtermLinkFactory: typeof XtermLinkFactory = ...

default

default: ContainerModule

default

default: ContainerModule

Const shellTerminalPath

shellTerminalPath: "/services/shell-terminal" = '/services/shell-terminal'

Const terminalAnsiColorMap

terminalAnsiColorMap: {} = ...

It should be aligned with https://github.com/microsoft/vscode/blob/0dfa355b3ad185a6289ba28a99c141ab9e72d2be/src/vs/workbench/contrib/terminal/common/terminalColorRegistry.ts#L40

Type declaration

[key: string]: { defaults: ColorDefaults; index: number }
- defaults: ColorDefaults
- index: number

Const terminalPath

terminalPath: "/services/terminal" = '/services/terminal'

Const terminalsPath

terminalsPath: "/services/terminals" = '/services/terminals'

Functions

bindTerminalPreferences

bindTerminalPreferences(bind: Bind): void

- Defined in packages/terminal/src/browser/terminal-preferences.ts:419
Parameters
- bind: Bind
Returns void

bindTerminalServer

bindTerminalServer(bind: Bind, __namedParameters: { constructor: (new (...args: any[]) => IBaseTerminalServer); identifier: ServiceIdentifier<IBaseTerminalServer>; path: string }): void

- Defined in packages/terminal/src/node/terminal-backend-module.ts:30
Parameters
- bind: Bind
- __namedParameters: { constructor: (new (...args: any[]) => IBaseTerminalServer); identifier: ServiceIdentifier<IBaseTerminalServer>; path: string }
  - constructor: (new (...args: any[]) => IBaseTerminalServer)
    - - new (...args: any[]): IBaseTerminalServer
      - Parameters
        Rest ...args: any[]
        Returns IBaseTerminalServer
  - identifier: ServiceIdentifier<IBaseTerminalServer>
  - path: string
Returns void

convertLinkRangeToBuffer

convertLinkRangeToBuffer(lines: IBufferLine[], bufferWidth: number, range: TerminalRange, startLine: number): IBufferRange

- Defined in packages/terminal/src/browser/terminal-link-helpers.ts:81
Converts a possibly wrapped link's range (comprised of string indices) into a buffer range that plays nicely with xterm.js

Parameters
- lines: IBufferLine[]
  
  A single line (not the entire buffer)
- bufferWidth: number
  
  The number of columns in the terminal
- range: TerminalRange
  
  The link range - string indices
- startLine: number
  
  The absolute y position (on the buffer) of the line
Returns IBufferRange

createCommonBindings

createCommonBindings(bind: Bind): void

- Defined in packages/terminal/src/common/terminal-common-module.ts:25
Create the bindings common to node and browser.

Parameters
- bind: Bind
  
  The bind function from inversify.
Returns void

createTerminalPreferences

createTerminalPreferences(preferences: PreferenceService, schema?: PreferenceSchema): TerminalPreferences

- Defined in packages/terminal/src/browser/terminal-preferences.ts:415
Parameters
- preferences: PreferenceService
- schema: PreferenceSchema = TerminalConfigSchema
Returns TerminalPreferences

createTerminalSearchFactory

createTerminalSearchFactory(container: Container): TerminalSearchWidgetFactory

- Defined in packages/terminal/src/browser/search/terminal-search-container.ts:21
Parameters
- container: Container
Returns TerminalSearchWidgetFactory

createTerminalTestContainer

createTerminalTestContainer(): Container

- Defined in packages/terminal/src/node/test/terminal-test-container.ts:25
Returns Container

createXtermLinkFactory

createXtermLinkFactory(ctx: Context): XtermLinkFactory

- Defined in packages/terminal/src/browser/terminal-link-provider.ts:43
Parameters
- ctx: Context
Returns XtermLinkFactory

getLinkContext

getLinkContext(terminal: Terminal, line: number, maxLinkLength?: number): LinkContext

- Defined in packages/terminal/src/browser/terminal-link-helpers.ts:40
Parameters
- terminal: Terminal
- line: number
- maxLinkLength: number = 2000
Returns LinkContext

isTerminalRendererType

isTerminalRendererType(arg: unknown): arg is TerminalRendererType

- Defined in packages/terminal/src/browser/terminal-preferences.ts:407
Parameters
- arg: unknown
Returns arg is TerminalRendererType

Index

References

Namespaces

Enumerations

Classes

Interfaces

Type Aliases

Variables

Functions

References

TerminalContribution

bindTerminalServer

Type Aliases

ConfirmOnExitType

CursorStyle

CursorStyleVSCode

Profiles

SerializableEnvironmentVariableCollection

ShellProcessFactory

Type declaration

Parameters

options: ShellProcessOptions

Returns ShellProcess

ShellTerminalOSPreferences

Type Parameters

T

ShellTerminalServerProxy

TerminalLocationOptions

TerminalPreferences

TerminalRendererType

TerminalSearchWidgetFactory

Type declaration

Parameters

terminal: Terminal

Returns TerminalSearchWidget

XtermLinkFactory

Type declaration

Parameters

link: TerminalLink

terminal: TerminalWidgetImpl

context: LinkContext

Returns ILink

Variables

Const ContributedTerminalProfileStore

Const DEFAULT_TERMINAL_RENDERER_TYPE

Const ENVIRONMENT_VARIABLE_COLLECTIONS_KEY

Const IShellTerminalServer

Const ITerminalServer

Const LinkContext

Const NULL_PROFILE

Const ShellProcessFactory

Const ShellProcessOptions

Const ShellTerminalServerProxy

Const TERMINAL_SEARCH_WIDGET_FACTORY_ID

Const TERMINAL_WIDGET_FACTORY_ID

Const TerminalConfigSchema

Const TerminalContribution

Const TerminalLink

Const TerminalLinkProvider

Const TerminalPreferenceContribution

Const TerminalPreferences

Const TerminalProfileService

Const TerminalSearchWidgetFactory

Const TerminalService

Const TerminalWidgetOptions

Const UserTerminalProfileStore

Const XtermLink

Const XtermLinkFactory

default

default

Const shellTerminalPath

Const terminalAnsiColorMap

Type declaration

[key: string]: { defaults: ColorDefaults; index: number }

defaults: ColorDefaults

index: number

Const terminalPath

Const terminalsPath

Functions

bindTerminalPreferences