npm 包 @sundogrd/fileportal 使用教程

阅读时长 3 分钟读完

介绍

@sundogrd/fileportal 是一个基于 Node.js 的 npm 包,可以轻松地将文件上传到云端存储。与其他文件上传的 npm 包不同,@sundogrd/fileportal 提供了更多的灵活性和自定义性。

安装

你可以通过 npm 下载并安装 @sundogrd/fileportal

使用

以下是一个简单的使用示例:

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

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

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

以上代码将通过 FilePortal 类初始化一个连接到云端存储的对象,然后上传本地文件。

配置项

FilePortal 类干净、明晰的接口使你无需亲手编写复杂的算法,只需在 portalConfig 中输入相应的配置信息即可:

  • accessKey - 你在云端存储中登录的 SECRET_ID;
  • secretKey - 你在云端存储中登录的 SECRET_KEY;
  • endpoint - 云端存储的域名;
  • bucket - 存储桶名称。

文件上传

FilePortal 类的 upload() 方法可以上传本地文件。上传的文件需要符合以下的格式:

其中:

  • path - 本地文件路径(必填);
  • name - 文件名称(必填);
  • type - 文件类型(非必填)。

文件类型默认为文件后缀,你也可以手动指定。

上传成功后,响应将包含以下信息:

  • url 为上传成功后文件在云端存储上的 URL;
  • key 为用户在云端存储中自定义的 key。

总结

现在你可以轻松地使用 @sundogrd/fileportal 连接到云端存储,并上传你的文件了。通过文件上传实现了 Node.js 程序的云端存储功能,为前端 Ching-fang 同学提供了很大的方便,同时也是一个经验的积累。

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

纠错
反馈