SecureBlackbox Lite 2020 Node.js Edition

Questions / Feedback?

DeleteDir Method

Removes directory from the SFTP server.

Syntax

sftpclient.deleteDir(remoteDir, [callback])

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for this method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

Use RemoteDir to provide a path to the directory to be deleted.

Copyright (c) 2022 /n software inc. - All rights reserved.
SecureBlackbox Lite 2020 Node.js Edition - Version 20.0 [Build 8166]