Skip to content

Commit

Permalink
修改描述
Browse files Browse the repository at this point in the history
  • Loading branch information
RuanXinyu committed Sep 30, 2018
1 parent 895115a commit fec0aab
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,23 +50,23 @@ obsSync.syncFileToOBS("D:\\public\\images\\avast.png", {

| 名称 | 必选 | 默认值 | 描述 |
| -- | -- | -- |-- |
| server | 必填 | null | OBS服务器地址,以`https://`开头,不包含桶名称,\r\n比如`https://obs.cn-north-1.myhwclouds.com` |
| server | 必填 | null | OBS服务器地址,以`https://`开头,不包含桶名称,<br>比如`https://obs.cn-north-1.myhwclouds.com` |
| bucket |必填 | null | OBS桶名称 |
| accessKeyId | 必填 | null | 访问OBS的accessKeyId |
| secretAccessKey | 必填 | null | 访问OBS的secretAccessKey |
| localDir | 必填 | null | 本地同步目录的绝对路径 |
| localFilesIgnorePattern | 可选 | "^\\..*" | 本地忽略文件的正则表达式,\r\n该正则表达式会应用到文件相对于`localDir`的相对路径,路径分隔符为`/` |
| localFilesIgnorePattern | 可选 | "^\\..*" | 本地忽略文件的正则表达式,<br>该正则表达式会应用到文件相对于`localDir`的相对路径,路径分隔符为`/` |
| remoteDir | 可选 | / | 同步到远端的目录,路径分隔符为`/` |
| syncDeletedFiles | 可选 | yes | `yes`或者`no`, \r\n如果是`yes`,则本地文件删除后,OBS中的文件也会对应删除,\r\n但是`syncDeletedFilesIgnorePattern`匹配上的文件除外 |
| syncDeletedFilesIgnorePattern | 可选 | "^\\..*" | 远端忽略文件的正则表达式,\r\n该正则表达式会应用到文件相对于`remoteDir`的相对路径,路径分隔符为`/` |
| syncDeletedFiles | 可选 | yes | `yes`或者`no`, <br>如果是`yes`,则本地文件删除后,OBS中的文件也会对应删除,<br>但是`syncDeletedFilesIgnorePattern`匹配上的文件除外 |
| syncDeletedFilesIgnorePattern | 可选 | "^\\..*" | 远端忽略文件的正则表达式,<br>该正则表达式会应用到文件相对于`remoteDir`的相对路径,路径分隔符为`/` |

### syncFileToOBS(options)

同步本地目录的单个文件到OBS目录

| 名称 | 必选 | 默认值 | 描述 |
| -- | -- | -- |-- |
| server | 必填 | null | OBS服务器地址,以`https://`开头,不包含桶名称,\r\n比如`https://obs.cn-north-1.myhwclouds.com` |
| server | 必填 | null | OBS服务器地址,以`https://`开头,不包含桶名称,<br>比如`https://obs.cn-north-1.myhwclouds.com` |
| bucket |必填 | null | OBS桶名称 |
| accessKeyId | 必填 | null | 访问OBS的accessKeyId |
| secretAccessKey | 必填 | null | 访问OBS的secretAccessKey |
Expand Down

0 comments on commit fec0aab

Please sign in to comment.