@norvento/sftp-client

Norvento sftp client

Doc

Table of Contents

• SFTPClient
  • Parameters
  • listTree
    • Parameters
  • get
    • Parameters
  • getMultiple
    • Parameters
  • getAsBuffer
    • Parameters
  • putFile
    • Parameters
  • deleteFile
    • Parameters
• SFTPError
  • Parameters

SFTPClient

SFTPClient.

Parameters

• config {configuration_sftp: {host: string, username: string, password: string, port: number}, remote_path: string, local_path: string} config properties

listTree

Get all the directory files

Parameters

• dirPath String the path of the directory

get

Copy the file "remotepath" from the remote server to the "localpath" in the local server

Parameters

• remotePath String , the remote file path
• localPath String , the local destination path

getMultiple

Downloads the files form the sftp server to the local destination folder

Parameters

• remoteFiles Array<Object>

• Throws SFTPError error

getAsBuffer

Gets the file from the server and returns it as a buffer

Parameters

• remotePath string the remote server file path

putFile

Uploads a file to the server

Parameters

• filePath string the local path to the file
• remotePath string the server remote path

deleteFile

Deletes a file on the server

Parameters

• remotePath string the server file path

SFTPError

Extends Error

SFTPError

Parameters

• message string the error message
• data any the error data
• originalError Error the original error