Class FtpNest

Hierarchy

Nest
- FtpNest

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new FtpNest(e: Environment, host: string, port: number, username: string, password: string, checkEvery: number): FtpNest

Overwrites Nest.constructor
- Defined in lib/nest/ftpNest.ts:17
Parameters
- e: Environment
- host: string
- port: number
- username: string
- password: string
- checkEvery: number
Returns FtpNest

Properties

Protected _id

_id: string

Protected _name

_name: string

Protected _tunnel

_tunnel: Tunnel

Protected checkEvery

checkEvery: number

Protected checkEveryMs

checkEveryMs: number

Protected client

client: any

Protected config

config: object

Type declaration

Protected e

Accessors

id

get id(): string

Inherited from Nest.id
- Defined in lib/nest/nest.ts:23
Returns string

name

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

Inherited from Nest.name
- Defined in lib/nest/nest.ts:31
Returns string
Inherited from Nest.name
- Defined in lib/nest/nest.ts:35
Parameters
- name: string
Returns void

tunnel

get tunnel(): Tunnel

Inherited from Nest.tunnel
- Defined in lib/nest/nest.ts:39
Returns Tunnel

Methods

arrive

arrive(job: FileJob): void

Overwrites Nest.arrive
- Defined in lib/nest/ftpNest.ts:109
Parameters
- job: FileJob
Returns void

Protected getClient

getClient(): any

- Defined in lib/nest/ftpNest.ts:35
Returns any

load

load(): void

- Defined in lib/nest/ftpNest.ts:39
Returns void

register

register(tunnel: Tunnel): void

Inherited from Nest.register
- Defined in lib/nest/nest.ts:43
Parameters
- tunnel: Tunnel
Returns void

take

take(job: FileJob, callback: any): void

Overwrites Nest.take
- Defined in lib/nest/ftpNest.ts:113
Parameters
- job: FileJob
- callback: any
Returns void

toString

toString(): string

Inherited from Nest.toString
- Defined in lib/nest/nest.ts:27
Returns string

watch

watch(): void

- Defined in lib/nest/ftpNest.ts:95
Returns void

Generated using TypeDoc