Browse Source

添加包说明

ifbbprochris 5 years ago
parent
commit
6b1d941173
1 changed files with 44 additions and 1 deletions
  1. 44
    1
      README.md

+ 44
- 1
README.md View File

@@ -1,3 +1,46 @@
1 1
 # upload_sdk
2 2
 
3
-上传插件,不包含上传的前端实现,只提供后端接口等,其他地方接入插件上传。包括上传进度、断点续传等
3
+上传插件,不包含上传的前端实现,只提供后端接口等,其他地方接入插件上传。包括上传进度、断点续传等
4
+
5
+## 使用方法
6
+
7
+### 在 package.json 里添加 
8
+```
9
+"upload_sdk": "git+ssh://git@git.links123.net:npm/upload_sdk.git"
10
+```
11
+
12
+### 在文件中引入
13
+
14
+```
15
+import UploadSdk from 'upload_sdk'
16
+
17
+```
18
+
19
+### 初始化传入 host(api), origin(社区 'forum'), token, file
20
+```
21
+let uploadSdk = new UploadSdk(host,origin,token,file)
22
+```
23
+
24
+### 主要方法
25
+```
26
+//上传图片,默认实现断点续传,如果上次上传中断,第二次上传如果服务器那边还没过期会接着上传
27
+uploadSdk.imageUploadAction().then((res) => {
28
+      const { url } = res
29
+      this.updateFileList(file, url)
30
+    }).catch((err) => {
31
+      console.log(err)
32
+})
33
+
34
+//上传视频
35
+uploadSdk.videoUploadAction().then((res) => {
36
+      const { url } = res
37
+      this.updateFileList(file, url)
38
+    }).catch((err) => {
39
+      console.log(err)
40
+})
41
+
42
+//监听上传进度,用于有显示上传进度条的需求
43
+uploadSdk.onUpdateProgress( progress => {
44
+      console.log(progress)
45
+})
46
+```