Class ShellTerminalServer

Hierarchy (View Summary)

BaseTerminalServer
- ShellTerminalServer

Implements

IShellTerminalServer

Constructors

constructor

new ShellTerminalServer(
    shellFactory: ShellProcessFactory,
    processManager: ProcessManager,
    logger: ILogger,
): ShellTerminalServer
Parameters
- shellFactory: ShellProcessFactory
- processManager: ProcessManager
- logger: ILogger
Returns ShellTerminalServer
Overrides BaseTerminalServer.constructor
- Defined in packages/terminal/src/node/shell-terminal-server.ts:53

Properties

`Protected`client

client: undefined | IBaseTerminalClient = undefined

`Readonly`collections

collections: MultiKeyMap<string, EnvironmentVariableCollectionWithPersistence> = ...

`Protected`environmentUtils

environmentUtils: EnvironmentUtils

`Protected` `Readonly`logger

logger: ILogger

`Protected` `Readonly`processManager

processManager: ProcessManager

`Protected` `Readonly`shellFactory

shellFactory: ShellProcessFactory

`Protected`terminalToDispose

terminalToDispose: Map<number, DisposableCollection> = ...

Methods

applyToProcessEnvironment

applyToProcessEnvironment(
cwdUri: URI,
env: { [key: string]: null | string },
): void
Parameters
- cwdUri: URI
- env: { [key: string]: null | string }
Returns void
- Defined in packages/terminal/src/node/shell-terminal-server.ts:204

attach

attach(id: number): Promise<number>
Parameters
- id: number
Returns Promise<number>
Implementation of IShellTerminalServer.attach
Inherited from BaseTerminalServer.attach
- Defined in packages/terminal/src/node/base-terminal-server.ts:49

close

close(id: number): Promise<void>
Parameters
- id: number
Returns Promise<void>
Implementation of IShellTerminalServer.close
Inherited from BaseTerminalServer.close
- Defined in packages/terminal/src/node/base-terminal-server.ts:101

create

create(options: IShellTerminalServerOptions): Promise<number>
Parameters
- options: IShellTerminalServerOptions
Returns Promise<number>
Implementation of IShellTerminalServer.create
Overrides BaseTerminalServer.create
- Defined in packages/terminal/src/node/shell-terminal-server.ts:60

deleteCollection

deleteCollection(extensionIdentifier: string): void
Deletes an extension's environment variable collection.
Parameters
- extensionIdentifier: string
Returns void
Implementation of IShellTerminalServer.deleteCollection
- Defined in packages/terminal/src/node/shell-terminal-server.ts:263

dispose

dispose(): void
Dispose this object.

Returns void
Implementation of IShellTerminalServer.dispose
Inherited from BaseTerminalServer.dispose
- Defined in packages/terminal/src/node/base-terminal-server.ts:113

getCwdURI

getCwdURI(id: number): Promise<string>
Parameters
- id: number
Returns Promise<string>
Implementation of IShellTerminalServer.getCwdURI
Inherited from BaseTerminalServer.getCwdURI
- Defined in packages/terminal/src/node/base-terminal-server.ts:93

getDefaultShell

getDefaultShell(): Promise<string>
Returns Promise<string>
Implementation of IShellTerminalServer.getDefaultShell
Inherited from BaseTerminalServer.getDefaultShell
- Defined in packages/terminal/src/node/base-terminal-server.ts:109

getEnvVarCollectionDescriptionsByExtension

getEnvVarCollectionDescriptionsByExtension(
id: number,
): Promise<Map<string, (undefined | string | MarkdownString)[]>>
Parameters
- id: number
Returns Promise<Map<string, (undefined | string | MarkdownString)[]>>
Implementation of IShellTerminalServer.getEnvVarCollectionDescriptionsByExtension
- Defined in packages/terminal/src/node/shell-terminal-server.ts:292

getEnvVarCollections

getEnvVarCollections(): Promise<
[string, string, boolean, SerializableEnvironmentVariableCollection][],
>
Returns Promise<[string, string, boolean, SerializableEnvironmentVariableCollection][]>
Implementation of IShellTerminalServer.getEnvVarCollections
- Defined in packages/terminal/src/node/shell-terminal-server.ts:306

getProcessId

getProcessId(id: number): Promise<number>
Parameters
- id: number
Returns Promise<number>
Implementation of IShellTerminalServer.getProcessId
Inherited from BaseTerminalServer.getProcessId
- Defined in packages/terminal/src/node/base-terminal-server.ts:74

getProcessInfo

getProcessInfo(id: number): Promise<TerminalProcessInfo>
Parameters
- id: number
Returns Promise<TerminalProcessInfo>
Implementation of IShellTerminalServer.getProcessInfo
Inherited from BaseTerminalServer.getProcessInfo
- Defined in packages/terminal/src/node/base-terminal-server.ts:82

hasChildProcesses

hasChildProcesses(processId: undefined | number): Promise<boolean>
Parameters
- processId: undefined | number
Returns Promise<boolean>
Implementation of IShellTerminalServer.hasChildProcesses
- Defined in packages/terminal/src/node/shell-terminal-server.ts:165

`Protected`isValidShell

isValidShell(shell: string): boolean
Parameters
- shell: string
Returns boolean
- Defined in packages/terminal/src/node/shell-terminal-server.ts:130

matchesRootUri

matchesRootUri(cwdUri: URI, rootUri: string): boolean
Parameters
- cwdUri: URI
- rootUri: string
Returns boolean
- Defined in packages/terminal/src/node/shell-terminal-server.ts:232

`Protected`notifyClientOnExit

notifyClientOnExit(term: TerminalProcess): DisposableCollection
Parameters
- term: TerminalProcess
Returns DisposableCollection
Inherited from BaseTerminalServer.notifyClientOnExit
- Defined in packages/terminal/src/node/base-terminal-server.ts:135

onAttachAttempted

onAttachAttempted(id: number): Promise<void>
Parameters
- id: number
Returns Promise<void>
Implementation of IShellTerminalServer.onAttachAttempted
Inherited from BaseTerminalServer.onAttachAttempted
- Defined in packages/terminal/src/node/base-terminal-server.ts:60

resize

resize(id: number, cols: number, rows: number): Promise<void>
Parameters
- id: number
- cols: number
- rows: number
Returns Promise<void>
Implementation of IShellTerminalServer.resize
Inherited from BaseTerminalServer.resize
- Defined in packages/terminal/src/node/base-terminal-server.ts:117

restorePersisted

restorePersisted(jsonValue: string): void
Parameters
- jsonValue: string
Returns void
Implementation of IShellTerminalServer.restorePersisted
- Defined in packages/terminal/src/node/shell-terminal-server.ts:257

setClient

setClient(client: undefined | IBaseTerminalClient): void
Set the client to receive notifications on.
Parameters
- client: undefined | IBaseTerminalClient
Returns void
Implementation of IShellTerminalServer.setClient
Inherited from BaseTerminalServer.setClient
- Defined in packages/terminal/src/node/base-terminal-server.ts:127

setCollection

setCollection(
    extensionIdentifier: string,
    baseUri: string,
    persistent: boolean,
    collection: SerializableEnvironmentVariableCollection,
): void
some code copied and modified from https://github.com/microsoft/vscode/blob/1.49.0/src/vs/workbench/contrib/terminal/common/environmentVariableService.ts
Parameters
- extensionIdentifier: string
- baseUri: string
- persistent: boolean
- collection: SerializableEnvironmentVariableCollection
Returns void
Implementation of IShellTerminalServer.setCollection
- Defined in packages/terminal/src/node/shell-terminal-server.ts:242

`Protected`validateTerminalOptions

validateTerminalOptions(options: IShellTerminalServerOptions): void
Validates and sanitizes terminal options received from the client. Invalid values are replaced with safe defaults rather than rejecting the request, so legitimate users with misconfigured preferences still get a working terminal.
Parameters
- options: IShellTerminalServerOptions
Returns void
- Defined in packages/terminal/src/node/shell-terminal-server.ts:81

Class ShellTerminalServer

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ShellTerminalServer

Properties

Protectedclient

Readonlycollections

ProtectedenvironmentUtils

Protected Readonlylogger

Protected ReadonlyprocessManager

Protected ReadonlyshellFactory

ProtectedterminalToDispose

Methods

applyToProcessEnvironment

Parameters

Returns void

attach

Parameters

Returns Promise<number>

close

Parameters

Returns Promise<void>

create

Parameters

Returns Promise<number>

deleteCollection

Parameters

Returns void

dispose

Returns void

getCwdURI

Parameters

Returns Promise<string>

getDefaultShell

Returns Promise<string>

getEnvVarCollectionDescriptionsByExtension

Parameters

Returns Promise<Map<string, (undefined | string | MarkdownString)[]>>

getEnvVarCollections

Returns Promise<[string, string, boolean, SerializableEnvironmentVariableCollection][]>

getProcessId

Parameters

Returns Promise<number>

getProcessInfo

Parameters

Returns Promise<TerminalProcessInfo>

hasChildProcesses

Parameters

Returns Promise<boolean>

ProtectedisValidShell

Parameters

Returns boolean

matchesRootUri

Parameters

Returns boolean

ProtectednotifyClientOnExit

Parameters

Returns DisposableCollection

onAttachAttempted

Parameters

Returns Promise<void>

ProtectedpersistCollections

Returns void

ProtectedpostAttachAttempted

Parameters

Returns void

ProtectedpostCreate

Parameters

Returns void

resize

Parameters

Returns Promise<void>

restorePersisted

`Protected`client

`Readonly`collections

`Protected`environmentUtils

`Protected` `Readonly`logger

`Protected` `Readonly`processManager

`Protected` `Readonly`shellFactory

`Protected`terminalToDispose

`Protected`isValidShell

`Protected`notifyClientOnExit

`Protected`persistCollections

`Protected`postAttachAttempted

`Protected`postCreate

`Protected`validateTerminalOptions