Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Environment

The environment class controls all aspects of the antfarm environment, like options, logging, and constructing globally referenced objects.

Hierarchy

  • Environment

Index

Constructors

constructor

Properties

Protected _emailer

_emailer: Emailer

Protected _options

_options: AntfarmOptions

Protected _server

_server: Server

Protected hookInterfaceRoutes

hookInterfaceRoutes: Array<any> = []

Protected hookRoutes

hookRoutes: Array<any> = []

Protected logger

logger: Logger

Accessors

autoManagedFolderDirectory

  • get autoManagedFolderDirectory(): string

emailer

options

server

Methods

addWebhook

addWebhookInterface

Protected createEmailer

  • createEmailer(): void

Protected createServer

  • createServer(): void

log

  • log(type: number, message: string, actor?: any, instances?: Array<any>): void
  • Adds a log entry to the Logger instance.

    Parameters

    • type: number

      The log level. 0 = debug, 1 = info, 2 = warning, 3 = error

    • message: string

      Log message.

    • Optional actor: any

      Instance which triggers the action being logged.

    • Default value instances: Array<any> = []

      Array of of other involved instances.

      Example

      job.e.log(1, `Transferred to Tunnel "${tunnel.getName()}".`, job, [oldTunnel]);
      

    Returns void

toString

  • toString(): string

Generated using TypeDoc