Search
Preparing search index...
The search index is not available
Theia TypeDoc
Options
All
Public
Public/Protected
All
Inherited
Menu
Theia TypeDoc
terminal
ShellTerminalServer
Class ShellTerminalServer
Hierarchy
BaseTerminalServer
ShellTerminalServer
Index
Constructors
constructor
Properties
client
collections
environment
Utils
logger
merged
Collection
process
Manager
shell
Factory
terminal
ToDispose
Methods
attach
close
create
delete
Collection
dispose
get
CwdURI
get
Default
Shell
get
Process
Id
get
Process
Info
has
Child
Processes
on
Attach
Attempted
persist
Collections
post
Create
resize
set
Client
set
Collection
spawn
AsPromised
Constructors
constructor
new
Shell
Terminal
Server
(
shellFactory
:
ShellProcessFactory
, processManager
:
ProcessManager
, logger
:
ILogger
)
:
ShellTerminalServer
Parameters
shellFactory:
ShellProcessFactory
processManager:
ProcessManager
logger:
ILogger
Returns
ShellTerminalServer
Properties
Protected
client
client
:
undefined
|
IBaseTerminalClient
= ...
Readonly
collections
collections
:
Map
<
string
,
EnvironmentVariableCollectionWithPersistence
>
= ...
Gets a single collection constructed by merging all environment variable collections into one.
Protected
environment
Utils
environment
Utils
:
EnvironmentUtils
Protected
Readonly
logger
logger
:
ILogger
merged
Collection
merged
Collection
:
MergedEnvironmentVariableCollection
Gets a single collection constructed by merging all environment variable collections into one.
Protected
Readonly
process
Manager
process
Manager
:
ProcessManager
Protected
Readonly
shell
Factory
shell
Factory
:
ShellProcessFactory
Protected
terminal
ToDispose
terminal
ToDispose
:
Map
<
number
,
DisposableCollection
>
= ...
Methods
attach
attach
(
id
:
number
)
:
Promise
<
number
>
Parameters
id:
number
Returns
Promise
<
number
>
close
close
(
id
:
number
)
:
Promise
<
void
>
Parameters
id:
number
Returns
Promise
<
void
>
create
create
(
options
:
IShellTerminalServerOptions
)
:
Promise
<
number
>
Parameters
options:
IShellTerminalServerOptions
Returns
Promise
<
number
>
delete
Collection
delete
Collection
(
extensionIdentifier
:
string
)
:
void
Parameters
extensionIdentifier:
string
Returns
void
dispose
dispose
(
)
:
void
Returns
void
get
CwdURI
get
CwdURI
(
id
:
number
)
:
Promise
<
string
>
Parameters
id:
number
Returns
Promise
<
string
>
get
Default
Shell
get
Default
Shell
(
)
:
Promise
<
string
>
Returns
Promise
<
string
>
get
Process
Id
get
Process
Id
(
id
:
number
)
:
Promise
<
number
>
Parameters
id:
number
Returns
Promise
<
number
>
get
Process
Info
get
Process
Info
(
id
:
number
)
:
Promise
<
TerminalProcessInfo
>
Parameters
id:
number
Returns
Promise
<
TerminalProcessInfo
>
has
Child
Processes
has
Child
Processes
(
processId
:
undefined
|
number
)
:
Promise
<
boolean
>
Parameters
processId:
undefined
|
number
Returns
Promise
<
boolean
>
on
Attach
Attempted
on
Attach
Attempted
(
id
:
number
)
:
Promise
<
void
>
Parameters
id:
number
Returns
Promise
<
void
>
Protected
persist
Collections
persist
Collections
(
)
:
void
Returns
void
Protected
post
Create
post
Create
(
term
:
TerminalProcess
)
:
void
Parameters
term:
TerminalProcess
Returns
void
resize
resize
(
id
:
number
, cols
:
number
, rows
:
number
)
:
Promise
<
void
>
Parameters
id:
number
cols:
number
rows:
number
Returns
Promise
<
void
>
set
Client
set
Client
(
client
:
undefined
|
IBaseTerminalClient
)
:
void
Parameters
client:
undefined
|
IBaseTerminalClient
Returns
void
set
Collection
set
Collection
(
extensionIdentifier
:
string
, persistent
:
boolean
, collection
:
SerializableEnvironmentVariableCollection
)
:
void
Parameters
extensionIdentifier:
string
persistent:
boolean
collection:
SerializableEnvironmentVariableCollection
Returns
void
Private
spawn
AsPromised
spawn
AsPromised
(
command
:
string
, args
:
string
[]
)
:
Promise
<
string
>
Parameters
command:
string
args:
string
[]
Returns
Promise
<
string
>
Exports
terminal
IBase
Terminal
Server
Terminal
Commands
Terminal
Keybinding
Contexts
Terminal
Menus
Shell
Terminal
Server
constructor
client
collections
environment
Utils
logger
merged
Collection
process
Manager
shell
Factory
terminal
ToDispose
attach
close
create
delete
Collection
dispose
get
CwdURI
get
Default
Shell
get
Process
Id
get
Process
Info
has
Child
Processes
on
Attach
Attempted
persist
Collections
post
Create
resize
set
Client
set
Collection
spawn
AsPromised
Gets a single collection constructed by merging all environment variable collections into one.