Class SFTPClient

Represents a SFTP connection.

Hierarchy

SFTPClient

Index

Constructors

Methods

cd chmod chown get getHome ls mkdir put pwd rm rmdir symlink

Constructors

constructor

new SFTPClient(): SFTPClient
Returns SFTPClient

Methods

cd

cd(path): void
Change directory to the given path
Parameters
- path: string
Returns void
- Defined in B.d.ts:2521

chmod

chmod(path, param): void
Change properties of given file
Parameters
- path: string
- param: number
Returns void
- Defined in B.d.ts:2566

chown

chown(path, param): void
Change ownership of given file
Parameters
- path: string
- param: number
Returns void
- Defined in B.d.ts:2573

get

get(destination, src): void
Download file to an output stream
Parameters
- destination: OutputStream
- src: string
Returns void
- Defined in B.d.ts:2528

getHome

getHome(): string
Download file to an output stream

Returns string
- Defined in B.d.ts:2533

ls

ls(path): LsEntry[]
List given directory
Parameters
- path: string
Returns LsEntry[]
- Defined in B.d.ts:2603

mkdir

mkdir(dir): void
Create a folder in the given directory
Parameters
- dir: string
Returns void
- Defined in B.d.ts:2559

put

put(file, dir): void
Look a file up in the local server and send it to the remote sever in the given directory
Parameters
- file: string
- dir: string
Returns void
- Defined in B.d.ts:2540
put(file, dir): void
Put a file to the remote sever in the given directory
Parameters
- file: InputStream
- dir: string
Returns void
- Defined in B.d.ts:2547
put(dir): OutputStream
Put a file to the remote sever in the given directory
Parameters
- dir: string
Returns OutputStream
- Defined in B.d.ts:2553

pwd

pwd(): string
Returns the current remote directory in absolute form

Returns string
- Defined in B.d.ts:2590

rm

rm(path): void
Remove given file
Parameters
- path: string
Returns void
- Defined in B.d.ts:2579

rmdir

rmdir(path): void
Remove given directory
Parameters
- path: string
Returns void
- Defined in B.d.ts:2585

symlink

symlink(oldPath, newPath): void
Creates a new Symbolic Link
Parameters
- oldPath: string
- newPath: string
Returns void
- Defined in B.d.ts:2597

Generated using TypeDoc