up2oss
v1.6.2
Published
A faster, lighter oss upload component
Downloads
3
Readme
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 获取相应结果。
参数说明:
- req.attachments: 上传文件列表
- 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");
});
其他说明
如何自定义文件夹?
- 通过参数
path
设置,默认为 bucket 根目录。 - 初始化配置设置是全局属性,所有上传路由均生效。
- FORM 表单设置是局部属性,仅当前路由生效。
- 两者同时设置时优先级:表单参数 > 初始化参数
- 通过参数
如何设置文件是否覆盖?
- 通过参数
ow
设置,默认为 false - 设置方法与
path
设置相似 。
- 通过参数