terminal | Theia TypeDoc

Index

References

bindTerminalServer

Namespaces

Enumerations

EnvironmentVariableMutatorType

Interfaces

Type aliases

Properties

Functions

References

bindTerminalServer

Re-exports bindTerminalServer

Type aliases

CursorStyle

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

CursorStyleVSCode

CursorStyleVSCode: CursorStyle | "line"

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>

TerminalPreferences

TerminalPreferences: PreferenceProxy<TerminalConfiguration>

TerminalRendererType

TerminalRendererType: "canvas" | "dom"

TerminalSearchWidgetFactory

TerminalSearchWidgetFactory: (terminal: Terminal) => TerminalSearchWidget

Type declaration

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

Properties

default

default: ContainerModule

default

default: ContainerModule

Variables

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 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 TerminalPreferenceContribution

TerminalPreferenceContribution: typeof TerminalPreferenceContribution = ...

Const TerminalPreferences

TerminalPreferences: typeof TerminalPreferences = ...

Const TerminalSearchWidgetFactory

TerminalSearchWidgetFactory: typeof TerminalSearchWidgetFactory = ...

Const TerminalService

TerminalService: typeof TerminalService = ...

Service manipulating terminal widgets.

Const TerminalWidgetOptions

TerminalWidgetOptions: typeof TerminalWidgetOptions = ...

Terminal widget options.

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: interfaces.Bind): void

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

bindTerminalServer

bindTerminalServer(bind: interfaces.Bind, __namedParameters: { constructor: {}; identifier: interfaces.ServiceIdentifier<IBaseTerminalServer>; path: string }): void

- Defined in packages/terminal/src/node/terminal-backend-module.ts:30
Parameters
- bind: interfaces.Bind
- __namedParameters: { constructor: {}; identifier: interfaces.ServiceIdentifier<IBaseTerminalServer>; path: string }
  - constructor: {}
  - identifier: interfaces.ServiceIdentifier<IBaseTerminalServer>
  - path: string
Returns void

createCommonBindings

createCommonBindings(bind: interfaces.Bind): void

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

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

createTerminalPreferences

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

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

createTerminalSearchFactory

createTerminalSearchFactory(container: interfaces.Container): TerminalSearchWidgetFactory

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

createTerminalTestContainer

createTerminalTestContainer(): Container

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

isTerminalRendererType

isTerminalRendererType(arg: any): arg is TerminalRendererType

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

Index

References

Namespaces

Enumerations

Classes

Interfaces

Type aliases

Properties

Variables

Functions

References

bindTerminalServer

Type aliases

CursorStyle

CursorStyleVSCode

SerializableEnvironmentVariableCollection

ShellProcessFactory

Type declaration

Parameters

options: ShellProcessOptions

Returns ShellProcess

ShellTerminalOSPreferences

Type parameters

T

ShellTerminalServerProxy

TerminalPreferences

TerminalRendererType

TerminalSearchWidgetFactory

Type declaration

Parameters

terminal: Terminal

Returns TerminalSearchWidget

Properties

default

default

Variables

Const DEFAULT_TERMINAL_RENDERER_TYPE

Const ENVIRONMENT_VARIABLE_COLLECTIONS_KEY

Const IShellTerminalServer

Const ITerminalServer

Const ShellProcessFactory

Const ShellProcessOptions

Const ShellTerminalServerProxy

Const TERMINAL_SEARCH_WIDGET_FACTORY_ID

Const TERMINAL_WIDGET_FACTORY_ID

Const TerminalConfigSchema

Const TerminalContribution

Const TerminalPreferenceContribution

Const TerminalPreferences

Const TerminalSearchWidgetFactory

Const TerminalService

Const TerminalWidgetOptions

Const shellTerminalPath

Const terminalAnsiColorMap

Type declaration

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

defaults: ColorDefaults

index: number

Const terminalPath

Const terminalsPath

Functions

bindTerminalPreferences

Parameters

bind: interfaces.Bind

Returns void

bindTerminalServer

Parameters

bind: interfaces.Bind

__namedParameters: { constructor: {}; identifier: interfaces.ServiceIdentifier<IBaseTerminalServer>; path: string }

constructor: {}

identifier: interfaces.ServiceIdentifier<IBaseTerminalServer>

path: string

Returns void

createCommonBindings

Parameters

bind: interfaces.Bind

Returns void

createTerminalPreferences

Parameters

preferences: PreferenceService