介绍
sftp-promises-with-promises 是一个基于 promises 的 sftp 客户端包，依赖于 ssh2-sftp-client。sftp-promises-with-promises 让你能够简单地使用 promises API，而无需关心回调。
安装
使用 npm 进行安装：
npm install sftp-promises-with-promises
使用
连接到 sftp 服务器
-- -------------------- ---- -------
----- ---------- - ---------------------------------------
----- ---- - --- -------------
--------------
----- --------------
----- -----
--------- -----------
--------- ----------
---------- -- -
-------------------------
-------------- -- -
-----------------
------------- -- -
-----------
---上传文件到 sftp 服务器
-- -------------------- ---- -------
----- ---------- - ---------------------------------------
----- ---- - --- -------------
--------------
----- --------------
----- -----
--------- -----------
--------- ----------
---------- -- -
-------------------------
------ -------------------------- -------------------
---------- -- -
----------------- -----------
-------------- -- -
-----------------
------------- -- -
-----------
---下载文件从 sftp 服务器
-- -------------------- ---- -------
----- ---------- - ---------------------------------------
----- ---- - --- -------------
--------------
----- --------------
----- -----
--------- -----------
--------- ----------
---------- -- -
-------------------------
------ --------------------------- ------------------
---------- -- -
----------------- -------------
-------------- -- -
-----------------
------------- -- -
-----------
---列出 sftp 服务器上的文件
-- -------------------- ---- -------
----- ---------- - ---------------------------------------
----- ---- - --- -------------
--------------
----- --------------
----- -----
--------- -----------
--------- ----------
---------- -- -
-------------------------
------ --------------------------
-------------- -- -
------------------
-------------- -- -
-----------------
------------- -- -
-----------
---API
connect(options)
连接到 sftp 服务器。options 对象包含 sftp 连接的配置。
options
Type: Object
host
要连接的 sftp 服务器的地址。
Type: String
port
要用于连接的端口号。如果未提供端口，则将使用默认端口 22。
Type: Number
username
要用于连接的 sftp 服务器的用户名。
Type: String
password
要用于连接的 sftp 服务器的密码。
Type: String
privateKey
用于连接的用户的私钥文件的路径。在指定密码的情况下，此选项将被忽略。
Type: String
passphrase
用于解密私钥文件的口令。在指定密码的情况下，此选项将被忽略。
Type: String
put(source, destination)
将本地文件上传到 sftp 服务器。
source
上传的本地文件的路径。
Type: String
destination
将在 sftp 服务器上创建的目标文件的路径。
Type: String
get(source, destination)
从 sftp 服务器下载文件。
source
要下载的 sftp 服务器上的文件的路径。
Type: String
destination
将在本地创建的目标文件的路径。
Type: String
list(path)
列出目录中的文件和文件夹。
path
要在 sftp 服务器上列出文件和文件夹的路径。
Type: String
结语
sftp-promises-with-promises 是一个强大的基于 promises 的 sftp 客户端包。您可以使用它轻松地上传和下载文件，而不需要处理回调。希望这篇文章能够帮助您了解如何使用 sftp-promises-with-promises。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/600559e281e8991b448d7745