Class ShellTerminalServer

Hierarchy (view full)

BaseTerminalServer
- ShellTerminalServer

Implements

IShellTerminalServer

Constructors

constructor

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

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, env): void
Parameters
- cwdUri: URI
- env: {
  [key: string]: string | null;
  }
  - [key: string]: string | null
Returns void
- Defined in packages/terminal/src/node/shell-terminal-server.ts:112

attach

attach(id): 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): 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): 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:53

deleteCollection

deleteCollection(extensionIdentifier): 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:171

dispose

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

`Private` doSetCollection

doSetCollection(extensionIdentifier, baseUri, persistent, collection): void
Parameters
- extensionIdentifier: string
- baseUri: string
- persistent: boolean
- collection: SerializableEnvironmentVariableCollection
Returns void
- Defined in packages/terminal/src/node/shell-terminal-server.ts:156

getCwdURI

getCwdURI(id): 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): 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:200

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:214

getProcessId

getProcessId(id): 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): 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): Promise<boolean>
Parameters
- processId: undefined | number
Returns Promise<boolean>
Implementation of IShellTerminalServer.hasChildProcesses
- Defined in packages/terminal/src/node/shell-terminal-server.ts:89

matchesRootUri

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

`Protected` notifyClientOnExit

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

onAttachAttempted

onAttachAttempted(id): 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

`Protected` persistCollections

persistCollections(): void
Returns void
- Defined in packages/terminal/src/node/shell-terminal-server.ts:180

`Protected` postAttachAttempted

postAttachAttempted(term): void
Parameters
- term: TaskTerminalProcess
Returns void
Inherited from BaseTerminalServer.postAttachAttempted
- Defined in packages/terminal/src/node/base-terminal-server.ts:169

`Protected` postCreate

postCreate(term): void
Parameters
- term: TerminalProcess
Returns void
Inherited from BaseTerminalServer.postCreate
- Defined in packages/terminal/src/node/base-terminal-server.ts:164

resize

resize(id, cols, rows): 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): void
Parameters
- jsonValue: string
Returns void
Implementation of IShellTerminalServer.restorePersisted
- Defined in packages/terminal/src/node/shell-terminal-server.ts:165

setClient

setClient(client): void
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, baseUri, persistent, collection): void
Sets an extension's environment variable collection.
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:150

`Private` spawnAsPromised

spawnAsPromised(command, args): Promise<string>
Parameters
- command: string
- args: string[]
Returns Promise<string>
- Defined in packages/terminal/src/node/shell-terminal-server.ts:69

`Private` updateCollections

updateCollections(): void
Returns void
- Defined in packages/terminal/src/node/shell-terminal-server.ts:176