SCP-async npm包的详细使用教程

阅读时长 3 分钟读完

SCP-async是一个可以使上传和下载SSH服务器上的文件变得更加简单的npm包,支持多个SSH服务器同时操作,同时还支持大文件的分割传输,非常适合于需要频繁上传和下载SSH服务器上的文件的前端开发者。

安装

使用npm安装该包:

npm install scp-async

或者使用yarn:

yarn add scp-async

如何使用

在使用之前,请确保你的电脑上已经安装了相应的SSH服务。

安装包之后,可以通过以下方式引入:

const SCP = require('scp-async');

然后,可以根据实际情况传入相应的参数,类似于:

-- -------------------- ---- -------
----- ------ - -
  ----- -----------------
  --------- -------
  --------- ----------
--

--------------------------------- ----------------------- --------------- -- -
  ----------------- ------------
-------------- -- -
  ------------------- -- ------ ------ - -----
---

上述代码使用SCP-async上传一个本地文件到远程服务器。

API文档

SCP.upload(localPath, remotePath, config, options)

上传文件到远程服务器。

  • options.chunkSize - 设置文件分块大小,默认为1M
  • options.timeout - 设置HTTP超时时间,默认为30秒

SCP.download(remotePath, localPath, config, options)

从远程服务器下载文件。

  • options.chunkSize - 设置文件分块大小,默认为1M
  • options.timeout - 设置HTTP超时时间,默认为30秒

示例代码

以下是一个示例代码,它将/path/to/local/file上传到/root/uploaded-file

-- -------------------- ---- -------
----- --- - ---------------------

----- ------ - -
  ----- -----------------
  --------- -------
  --------- ----------
--

--------------------------------- ---------------------- --------------- -- -
  ----------------- ------------
-------------- -- -
  ------------------- -- ------ ------ - -----
---

这个示例中,当文件上传成功时,控制台输出"File uploaded!",否则输出"Failed to upload file"。

小结

SCP-async本身就支持多个SSH服务器同时操作,同时还支持大文件的分割传输,非常适合于需要频繁上传和下载SSH服务器上的文件的前端开发者。使用SCP-async,你可以很方便地管理你的SSH文件,提高你的工作效率。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60066b5f51ab1864dac671f6

纠错
反馈