Class SFTPClient

Represents a SFTP connection.

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: string): void
Change directory to the given path
Parameters
- path: string
Returns void
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:1798

chmod

chmod(path: string, param: number): void
Change properties of given file
Parameters
- path: string
- param: number
Returns void
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:1843

chown

chown(path: string, param: number): void
Change ownership of given file
Parameters
- path: string
- param: number
Returns void
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:1850

get

get(destination: OutputStream, src: string): void
Download file to an output stream
Parameters
- destination: OutputStream
- src: string
Returns void
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:1805

getHome

getHome(): string
Download file to an output stream

Returns string
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:1810

ls

ls(path: string): LsEntry[]
List given directory
Parameters
- path: string
Returns LsEntry[]
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:1880

mkdir

mkdir(dir: string): void
Create a folder in the given directory
Parameters
- dir: string
Returns void
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:1836

put

put(file: string, dir: string): 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 work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:1817
put(file: InputStream, dir: string): void
Put a file to the remote sever in the given directory
Parameters
- file: InputStream
- dir: string
Returns void
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:1824
put(dir: string): OutputStream
Put a file to the remote sever in the given directory
Parameters
- dir: string
Returns OutputStream
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:1830

pwd

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

Returns string
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:1867

rm

rm(path: string): void
Remove given file
Parameters
- path: string
Returns void
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:1856

rmdir

rmdir(path: string): void
Remove given directory
Parameters
- path: string
Returns void
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:1862

symlink

symlink(oldPath: string, newPath: string): void
Creates a new Symbolic Link
Parameters
- oldPath: string
- newPath: string
Returns void
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/B.d.ts:1874