@mingto/obs-server 1.0.34 → 1.0.37

package/README.md

@@ -1,47 +1,92 @@
-`@mingto/obs-server` 是一款统一的 OBS 文件上传工具库，旨在简化并高效处理文件上传任务。该工具库会通过后端的 `file/config` 接口获取 OBS 配置信息，进而自动判断使用 `@mingto/huawei-obs-server` 还是 ` @mingto/aws-obs-server` 、`@mingto/minio-v2-obs-server` 来完成上传操作。
-
-# 安装
-
-```bash
-pnpm install @mingto/obs-server
-```
-
-# 使用
-
-## 示例代码
-
-```js
-import obsServer from '@mingto/obs-server'
-
-// 配置全局参数
-obsServer.config({
-  getToken: () => '用户的token',
-  fileSplitThreshold: 1024 * 1024 * 5
-})
-
-// 创建要上传的文件对象
-const sourceFile = new File(['hello world'], 'hello.txt', { type: 'text/plain' })
-
-// 创建上传实例
-const uploadContext = obsServer.create({
-  sourceFile,
-  onProgress: (event) => {
-    console.log(`Upload progress: ${event.percent}%`)
-  },
-  onSuccess: (event) => {
-    console.log('Upload success:', event.fileInfo)
-  }
-})
-
-// 取消上传示例
-// uploadContext.abort()
-
-```
-
-# 注意事项
-
-- 在使用该工具库时，首先会调用 `file/config` 接口来获取 OBS 的类型。
-  - 若返回值为 `aws`，则使用 `@mingto/aws-obs-server` 进行上传；
-  - 若返回值为 `huawei`，则使用 `@mingto/huawei-obs-server` 进行上传。
-  - 若返回值为 `minio`，则使用 `@mingto/minio-v2-obs-server` 进行上传。
-- `config` 和 `create` 等方法所需要的参数会根据具体使用的工具库（`@mingto/aws-obs-server` 或 `@mingto/huawei-obs-server` 或 `@mingto/minio-v2-obs-server`）来决定。请参考对应工具库的文档进行准确配置。
+# @mingto/obs-server
+
+统一的 OBS 文件上传工具库，旨在简化并高效处理文件上传任务。该工具库会自动判断使用 `@mingto/huawei-obs-server`、`@mingto/aws-obs-server` 或 `@mingto/minio-v2-obs-server` 来完成上传操作。
+
+## 特性
+
+- 🔄 **自动适配**：自动识别 OBS 类型并选择对应上传方式
+- 📦 **统一接口**：所有 OBS 类型使用相同的 API 接口
+- 🚀 **支持大文件**：自动分片上传
+- 📊 **进度监控**：实时上传进度回调
+- ❌ **取消上传**：支持随时取消上传操作
+
+## 安装
+
+```bash
+pnpm add @mingto/obs-server
+```
+
+## 快速开始
+
+```typescript
+import obsServer from '@mingto/obs-server'
+
+// 配置全局参数
+obsServer.config({
+  getToken: () => '用户的token',
+  fileSplitThreshold: 1024 * 1024 * 5
+})
+
+// 创建要上传的文件对象
+const sourceFile = new File(['hello world'], 'hello.txt', { type: 'text/plain' })
+
+// 创建上传实例
+const uploadContext = obsServer.create({
+  sourceFile,
+  onProgress: (event) => {
+    console.log(`上传进度: ${event.percent}%`)
+  },
+  onSuccess: (event) => {
+    console.log('上传成功:', event.fileInfo)
+  },
+  onError: (error) => {
+    console.error('上传失败:', error)
+  }
+})
+
+// 取消上传
+// uploadContext.abort()
+```
+
+## API
+
+### obsServer.config(options)
+
+全局配置方法。
+
+| 参数 | 类型 | 必填 | 说明 |
+|------|------|------|------|
+| getToken | `() => string` | 是 | 获取上传所需的 token |
+| fileSplitThreshold | `number` | 否 | 文件大小分隔线，默认 5MB |
+
+### obsServer.create(options)
+
+创建上传实例。
+
+| 参数 | 类型 | 必填 | 说明 |
+|------|------|------|------|
+| sourceFile | `File` | 是 | 要上传的文件对象 |
+| partSize | `number` | 否 | 分片大小，默认 5MB |
+| onStart | `() => void` | 否 | 上传开始回调 |
+| onProgress | `(event) => void` | 否 | 上传进度回调 |
+| onSuccess | `(event) => void` | 否 | 上传成功回调 |
+| onError | `(error) => void` | 否 | 上传失败回调 |
+| onAbort | `() => void` | 否 | 取消上传回调 |
+| onFinally | `() => void` | 否 | 上传结束回调 |
+
+## 注意事项
+
+1. **OBS 类型自动判断**：工具库会调用后端 `file/config` 接口获取 OBS 类型
+   - 返回 `aws` → 使用 `@mingto/aws-obs-server`
+   - 返回 `huawei` → 使用 `@mingto/huawei-obs-server`
+   - 返回 `minio` → 使用 `@mingto/minio-v2-obs-server`
+
+2. **参数配置**：具体参数配置请参考对应工具库的文档
+
+## 完整文档
+
+更多详细用法请参考 [官方文档](https://mingto.github.io/mt-utils/npm/obs-server/)
+
+## 许可证
+
+MIT