Class Server

An HTTP server instance that allows to control the tool using a REST interface. Moreover, it allows to aggregate stats data coming from multiple running tool instances.

Constructors

constructor

Properties

pageLogPath serverData serverPort serverSecret serverUseHttps stats

Methods

start stop

Constructors

constructor

  • new Server(__namedParameters?, stats): Server

  • Server instance. All the HTTP endpoints are protected by basic authentication with user admin and password Server.serverSecret.

    Parameters

    • __namedParameters: {
          pageLogPath: undefined | string;
          serverData: undefined | string;
          serverPort: undefined | number;
          serverSecret: undefined | string;
          serverUseHttps: undefined | boolean;
      } = {}
      • pageLogPath: undefined | string
      • serverData: undefined | string
      • serverPort: undefined | number
      • serverSecret: undefined | string
      • serverUseHttps: undefined | boolean
    • stats: Stats

      A Stats class instance.

    Returns Server

Properties

pageLogPath

pageLogPath: string

The file path that will be used to serve the /view/page.log requests.

serverData

serverData: string

An optional path that the HTTP server will expose with the /data endpoint.

ReadonlyserverPort

serverPort: number

The server listening port.

ReadonlyserverSecret

serverSecret: string

The basic auth secret.

ReadonlyserverUseHttps

serverUseHttps: boolean

If HTTPS protocol should be used.

stats

stats: Stats

A Stats class instance.

Methods

start

stop

Settings

Member Visibility

On This Page

Constructors
Properties
Methods