克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
MIT

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设置相似 。
MIT License Copyright (c) 2024 Juuen Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

简介

一个灵巧、快捷和方便的 oss 上传组件 展开 收起
JavaScript
MIT
取消

发行版

暂无发行版

贡献者

全部

近期动态

不能加载更多了
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化