Class Tunnel

Tunnels are runnable work flow units that can watch nests.

Hierarchy

Tunnel

Index

Constructors

constructor

Properties

Accessors

Methods

Object literals

match_obj

Constructors

constructor

new Tunnel(e: Environment, tunnelName: string): Tunnel

- Defined in lib/tunnel/tunnel.ts:30
Parameters
- e: Environment
- tunnelName: string
Returns Tunnel

Properties

Private _id

_id: string

Protected _name

_name: string

Protected _nests

_nests: Nest[]

Protected _run_fail

_run_fail: any

Protected _run_list

_run_list: any[]

Protected _run_sync_list

_run_sync_list: any[]

Protected e

Protected job_counter

job_counter: number

Accessors

id

get id(): string

- Defined in lib/tunnel/tunnel.ts:74
Returns string

name

get name(): string
set name(name: string): void

- Defined in lib/tunnel/tunnel.ts:46
Returns string
- Defined in lib/tunnel/tunnel.ts:50
Parameters
- name: string
Returns void

nests

get nests(): Array<Nest>

- Defined in lib/tunnel/tunnel.ts:54
Returns Array<Nest>

runFail

get runFail(): any
set runFail(callback: any): void

- Defined in lib/tunnel/tunnel.ts:66
Returns any
- Defined in lib/tunnel/tunnel.ts:70
Parameters
- callback: any
Returns void

runList

get runList(): Array<any>

- Defined in lib/tunnel/tunnel.ts:58
Returns Array<any>

runSyncList

get runSyncList(): Array<any>

- Defined in lib/tunnel/tunnel.ts:62
Returns Array<any>

Methods

arrive

arrive(job: Job, nest?: Nest): void

- Defined in lib/tunnel/tunnel.ts:91
Parameters
- job: Job
- Optional nest: Nest
Returns void

executeFail

executeFail(job: Job, nest: Nest, reason: string): void

- Defined in lib/tunnel/tunnel.ts:178
Fail run event.

Parameters
- job: Job
- nest: Nest
- reason: string
Returns void

Protected executeMatch

executeMatch(job: Job, nest: Nest): void

- Defined in lib/tunnel/tunnel.ts:207
Match execution

Parameters
- job: Job
- nest: Nest
Returns void

Protected executeRun

executeRun(job: Job, nest: Nest): void

- Defined in lib/tunnel/tunnel.ts:128
Asynchronous run event.

Parameters
- job: Job
- nest: Nest
Returns void

Protected executeRunSync

executeRunSync(job: Job, nest: Nest): void

- Defined in lib/tunnel/tunnel.ts:148
Synchronous run event.

Parameters
- job: Job
- nest: Nest
Returns void

fail

fail(callback: function): void

- Defined in lib/tunnel/tunnel.ts:119
Failed jobs runner.

Parameters
- callback: function
  - - (job: Job, nest: Nest, reason: string): void
    - Parameters
      - job: Job
      - nest: Nest
      - reason: string
      Returns void
Returns void

match

match(pattern: string[] | string, orphanMinutes: number, callback: any): void

- Defined in lib/tunnel/tunnel.ts:196
Interface for matching two or more _files together based on an array of glob filename patterns.

Parameters
- pattern: string[] | string
- orphanMinutes: number
- callback: any
Returns void

run

run(callback: function): void

- Defined in lib/tunnel/tunnel.ts:103
Run program logic asynchronously.

Parameters
- callback: function
  - - (job: Job, nest: Nest): void
    - Parameters
      - job: Job
      - nest: Nest
      Returns void
Returns void

runSync

runSync(callback: function): void

- Defined in lib/tunnel/tunnel.ts:111
Run program logic synchronously.

Parameters
- callback: function
  - - (job: Job, nest: Nest, done: any): void
    - Parameters
      - job: Job
      - nest: Nest
      - done: any
      Returns void
Returns void

toString

toString(): string

- Defined in lib/tunnel/tunnel.ts:42
Returns string

watch

watch(nest: FolderNest | WebhookNest | FtpNest): void

- Defined in lib/tunnel/tunnel.ts:82
Instructs the tunnel to watch a nest for new jobs.

Parameters
- nest: FolderNest | WebhookNest | FtpNest
Returns void

Object literals

Protected match_obj

match_obj: object

orphan_minutes

orphan_minutes: null = null

pattern

pattern: null = null

queue

queue: Array<undefined> = []

run

run: null = null

Generated using TypeDoc