Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ShellServerOptions

The configurations options for the shell server.

Hierarchy

  • ShellServerOptions

Index

Constructors

constructor

Methods

getReaperInterval

  • getReaperInterval(): number
  • Set the repear interval, i.e the period at which session eviction is performed.

    Returns number

getSessionTimeout

  • getSessionTimeout(): number
  • Set the session timeout.

    Returns number

getWelcomeMessage

  • getWelcomeMessage(): string
  • Set the shell welcome message, i.e the message displayed in the user console when he connects to the shell.

    Returns string

setReaperInterval

  • Set the repear interval, i.e the period at which session eviction is performed.

    Parameters

    • reaperInterval: number

    Returns ShellServerOptions

setSessionTimeout

  • Set the session timeout.

    Parameters

    • sessionTimeout: number

    Returns ShellServerOptions

setWelcomeMessage

  • Set the shell welcome message, i.e the message displayed in the user console when he connects to the shell.

    Parameters

    • welcomeMessage: string

    Returns ShellServerOptions

Generated using TypeDoc