Module TerminalSession

The namespace for ISession statics.

Index

Interfaces

Type aliases

MessageType

Functions

Type aliases

MessageType

MessageType: "stdout" | "disconnect" | "set_size" | "stdin"

Valid message types for the terminal.

Functions

connectTo

connectTo(name: string, options?: IOptions): Promise<ISession>

- Defined in terminal/terminal.ts:113
Parameters
- name: string
- Optional options: IOptions
Returns Promise<ISession>

isAvailable

isAvailable(): boolean

- Defined in terminal/terminal.ts:80
Test whether the terminal service is available.

Returns boolean

listRunning

listRunning(settings?: ISettings): Promise<IModel[]>

- Defined in terminal/terminal.ts:127
List the running terminal sessions.

Parameters
- Optional settings: ISettings
  
  The server settings to use.
Returns Promise<IModel[]>

A promise that resolves with the list of running session models.

shutdown

shutdown(name: string, settings?: ISettings): Promise<void>

- Defined in terminal/terminal.ts:142
Shut down a terminal session by name.

Parameters
- name: string
  
  The name of the target session.
- Optional settings: ISettings
  
  The server settings to use.
Returns Promise<void>

A promise that resolves when the session is shut down.

shutdownAll

shutdownAll(settings?: ISettings): Promise<void>

- Defined in terminal/terminal.ts:154
Shut down all terminal sessions.

Parameters
- Optional settings: ISettings
Returns Promise<void>

A promise that resolves when all of the sessions are shut down.

startNew

startNew(options?: IOptions): Promise<ISession>

- Defined in terminal/terminal.ts:91
Start a new terminal session.

Parameters
- Optional options: IOptions
  
  The session options to use.
Returns Promise<ISession>

A promise that resolves with the session instance.

Generated using TypeDoc