up2oss

1.6.2 • Public • Published

UP2OSS

一个灵巧、快捷和方便的 oss 上传中间件

安装

npm install up2oss

使用

初始化配置

EXPRESS 项目推荐使用 app.js 配置,示例如下:

const { UP2OSS } = require("up2oss");
const up2oss = new UP2OSS({
	accessKeyId: "your accessKeyId",
	accessKeySecret: "your accessKeySecret",
	bucket: "your bucket",
	region: "your region"
});

// 全局路由
app.use(up2oss.upload);

// 指定路由
app.use("/upload", up2oss.upload);

获取 OSS 上传结果

通过路由回调函数参数 req 获取相应结果。

参数说明:

  1. req.attachments: 上传文件列表
  2. req.fields: 上传字段列表
对象 字段 描述
attachments name 文件名
attachments size 文件大小
attachments url OSS 文件地址
fields name 字段名
fields content 字段值

示例:

router.post("/api/upload", (req, res) => {
	console.log("upload info: ", {
		attachments: req.attachments,
		fields: req.fields
	});
	res.end("upload successfully");
});

其他说明

  • 如何自定义文件夹?

    1. 通过参数 path 设置,默认为 bucket 根目录。
    2. 初始化配置设置是全局属性,所有上传路由均生效。
    3. FORM 表单设置是局部属性,仅当前路由生效。
    4. 两者同时设置时优先级:表单参数 > 初始化参数
  • 如何设置文件是否覆盖?

    1. 通过参数 ow 设置,默认为 false
    2. 设置方法与 path设置相似 。

Readme

Keywords

Package Sidebar

Install

npm i up2oss

Weekly Downloads

1

Version

1.6.2

License

ISC

Unpacked Size

12.4 kB

Total Files

8

Last publish

Collaborators

  • juuenlee