mysftp

Work with SFTP easily.

Install

npm install mysftp --save

Variables

This module will read four environment variables. If it doesn't find the related environment variable it will read the default value.

• SFTP_HOST: SFTP server address. (default: localhost)
• SFTP_PORT: SFTP port. (default: 21)
• SFTP_USR: SFTP users. (default: anonymous)
• SFTP_PWD: SFTP password. (default: no password)
• SFTP_ROOT_DIR: SFTP root directory. (default: no default directory)

Or you can pass connection configuration parameter to the method, this is example config parameter:

const config = {
    host: '127.0.0.1',
    port: '2222',
    username: 'anonymous',
    password: 'anonymous',
    root_dir: ''
}

Usage

Below is an example upload using method POST and headers Content-Type: multipart/form-data. In this example using express framework, so requires package express-fileupload and add this line in app.js/index.js.

const fileupload = require('express-fileupload')
app.use(fileupload())

then the following module will work fine.

const { uploadstream } = require('mysftp')

router.post('/upload', async (req, res) => {
    // FILENAME is key from form-data, replace with yours
    let buffer = req.files.FILENAME.data 
    let filename = req.files.FILENAME.name 
    let remoteFile = '/test/' + filename

    // upload to SFTP
    let retval = await uploadstream(buffer, remoteFile) // parameters avaliable: buffer, remoteFile, config
    console.log(retval)
    res.send(retval.message) // retval.message will be "Upload successful" if no error
})

Below is an example multiple file upload using method POST and headers Content-Type: multipart/form-data. In this example using express framework, so requires package express-fileupload and add this line in app.js/index.js.

const fileupload = require('express-fileupload')
app.use(fileupload())

then the following module will work fine.

const { multiuploadstream } = require('mysftp')

router.post('/upload', async (req, res) => {
    let files = Object.values(req.files)        
    let arrBuffer = []
    let arrRemoteFile = []

    files.forEach((element) => {
        arrBuffer.push(element.data)
        arrRemoteFile.push('/test/' + element.name)
    })

    // upload to SFTP
    let retval = await multiuploadstream(arrBuffer, arrRemoteFile) // parameters avaliable: arrBuffer, arrRemotefile, config
    console.log(retval)
    res.send(retval) // retval is an array

    // [
    //     { index: 0, message: 'Upload successful' },
    //     { index: 1, message: 'Upload successful' }
    // ]   
})

Below is an example download file from SFTP server to local directory.

const { downloadfile } = require('mysftp')

let localFile = './temp/test.txt'
let remoteFile = '/test.txt'
let retval = downloadfile(localFile, remoteFile) // parameters avaliable: localFile, remoteFile, isFast, config
console.log(retval.message) // retval.message will be "Download successful" if no error

You can use concurrency download file. Pass true parameter after remoteFile parameter to tweaking of the fast download process.

let retval = downloadfile(localFile, remoteFile, true) 

Below is an example upload file from local directory to SFTP server.

const { uploadfile } = require('mysftp')

let localFile = './temp/test.txt'
let remoteFile = '/test.txt'
let retval = uploadfile(localFile, remoteFile) // parameter avaliable: localFile, remoteFile, isFast, config
console.log(retval.message) // retval.message will be "Upload successful" if no error

You can use concurrency upload file. Pass true parameter after remoteFile parameter to tweaking of the fast upload process.

let retval = uploadfile(localFile, remoteFile, true) 

Below is an example of getting a list of directories on the SFTP server.

const { list } = require('mysftp')

let retval = await list('/') // parameters available: remoteDir, config
console.log(retval)

Below is an example of copying remote file into another remote file on the SFTP server.

const { copyfile } = require('mysftp')

let sourceFile = '/test.txt'
let destFile = '/another_test.txt'
let retval = copyfile(sourceFile, destFile) // parameter avaliable: sourceFile, destFile, config
console.log(retval.message) // retval.message will be "Copy file successful" if no error

Below is an example of deleting remote file on the SFTP server.

const { deletefile } = require('mysftp')

let remoteFile = '/test.txt'
let retval = deletefile(remoteFile) // parameter avaliable: remoteFile, noError, config
console.log(retval.message) // retval.message will be "Delete file successful" if no error

By default, an error will occur when the remote file does not exist. You can pass noErrorparameter set to true if you don't want raise the error.

let retval = deletefile(remoteFile, true)

That's all.

If you find this useful, please ⭐ the repository. Any feedback is welcome.

You can contribute or you want to, feel free to Buy me a coffee! :coffee:, I will be really thankfull for anything even if it is a coffee or just a kind comment towards my work, because that helps me a lot.

License

MIT