Class: SshTerminalSettings

domain~ SshTerminalSettings

Settings for a SSH terminal.


new SshTerminalSettings( [cols] [, lines] [, width] [, height] [, type] [, environment])

Constructor.

Parameters:
Name Type Argument Default Description
cols number <optional>
80

the characters width

lines number <optional>
24

the number of lines

width number <optional>
640

the pixel width

height number <optional>
480

the pixel height

type string <optional>
xterm

the terminal type

environment Map.<string, string> <optional>

environment properties to pass to the shell

Methods


<static> fromJsonEncoding(json)

Parse a JSON string into a module:domain~SshTerminalSettings instance.

The JSON must be encoded the same way module:domain~SshTerminalSettings#toJsonEncoding does.

Parameters:
Name Type Description
json string

the JSON to parse

Returns:

the session instance

Type
module:domain~SshTerminalSettings

toJsonEncoding()

Get this object as a standard JSON encoded string value.

Returns:

the JSON encoded string

Type
string