Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SSHTermOptions

The SSH term configuration options.

Hierarchy

  • SSHTermOptions

Index

Constructors

constructor

Methods

getAuthOptions

  • getAuthOptions(): {}
  • Set the auth options.

    Returns {}

    • [key: string]: any

getDefaultCharset

  • getDefaultCharset(): string
  • Set the default charset to use when the client does not specifies one.

    Returns string

getHost

  • getHost(): string
  • Set the host

    Returns string

getIntputrc

  • getIntputrc(): string
  • The path of the inputrc config.

    Returns string

getPort

  • getPort(): number
  • Set the port

    Returns number

setAuthOptions

  • Set the auth options.

    Parameters

    • authOptions: {}
      • [key: string]: any

    Returns SSHTermOptions

setDefaultCharset

  • Set the default charset to use when the client does not specifies one.

    Parameters

    • defaultCharset: string

    Returns SSHTermOptions

setHost

  • Set the host

    Parameters

    • host: string

    Returns SSHTermOptions

setIntputrc

  • The path of the inputrc config.

    Parameters

    • intputrc: string

    Returns SSHTermOptions

setKeyPairOptions

  • Set the key pair options in jks format, aka Java keystore.

    Parameters

    • keyPairOptions: JksOptions

    Returns SSHTermOptions

setPemKeyPairOptions

  • setPemKeyPairOptions(pemKeyPairOptions: PemKeyCertOptions): SSHTermOptions
  • Set the key pair store options in pem format.

    Parameters

    • pemKeyPairOptions: PemKeyCertOptions

    Returns SSHTermOptions

setPfxKeyPairOptions

  • Set the key pair options in pfx format.

    Parameters

    • pfxKeyPairOptions: PfxOptions

    Returns SSHTermOptions

setPort

  • Set the port

    Parameters

    • port: number

    Returns SSHTermOptions

Generated using TypeDoc