Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Antfarm

Expose Antfarm.

Hierarchy

  • Antfarm

Index

Constructors

constructor

Properties

Protected e

Methods

createFolderNest

  • createFolderNest(path: string, allowCreate?: boolean): FolderNest
  • Factory method which returns a FolderNest.

    Parameters

    • path: string

      Path of the folder.

    • Default value allowCreate: boolean = false

      Optional boolean flag to allow creation of folder if it does not exist.

    Returns FolderNest

createFtpNest

  • createFtpNest(host: string, port?: number, username?: string, password?: string, checkEvery?: number): FtpNest
  • Factory method which returns an FtpNest.

    Parameters

    • host: string

      Hostname or IP address of the FTP server.

    • Default value port: number = 21

      Port number of the FTP server.

    • Default value username: string = ""

      FTP account username.

    • Default value password: string = ""

      FTP account password.

    • Default value checkEvery: number = 10

      Frequency of re-checking FTP in minutes.

    Returns FtpNest

createTunnel

  • createTunnel(name: any): Tunnel

createWebhookNest

  • createWebhookNest(path: string | string[], httpMethod?: string): WebhookNest
  • Factory method which returns a WebhookNest.

    Parameters

    • path: string | string[]

      The path which is generated in the webhook's route. You can supply a string or array of strings.

    • Default value httpMethod: string = "all"

      HTTP method for this webhook. Choose "all" for any HTTP method.

    Returns WebhookNest

loadDir

  • loadDir(directory: string): void
  • Load an entire directory of workflow modules.

    Parameters

    • directory: string

      Path to the workflow modules.

    Returns void

version

  • version(): string

Generated using TypeDoc