Skip to content

Commit

Permalink
📖 调整文档
Browse files Browse the repository at this point in the history
  • Loading branch information
ossso committed Mar 29, 2022
1 parent ddb146e commit 64e8d71
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,19 +58,26 @@ deploy({
| ---- | ---- | ---- | ---- |
| **prefix** | `String` | - | 默认前缀路径 |
| **transfer** | `Array/Object` | null | 转移文件部署路径 |
| **ignoreRule** | `String` | - | 忽略文件规则,ignore通用规则,例外:忽略目录后,不会扫描该目录下的指定路径,有需求的请用transfer代替 |
| **ignoreRule** | `String` | - | 忽略文件规则,ignore通用规则,例外:忽略目录后,不会扫描该目录下的指定路径 |

`transfer`配置说明

| 属性 | 值类型 | 默认值 | 说明 |
| ---- | ---- | ---- | ---- |
| **match** | `String` | - | 匹配的路径名称,相对全名称 |
| **remotePath** | `String` | - | 被转移到的目标路径,绝对全名称 |
| **type** | `String` | 'copy' | 转移类型:`move` \| `copy` move转移后原来的列表不会存在此文件的任务 |
| **deployType** | `String` | - | 可以指定单个文件部署类型,默认原部署类型 |

----------

### `config:` 部署的上传服务配置

| 属性 | 值类型 | 默认值 | 说明 |
| ---- | ---- | ---- | ---- |
| **deployType** | `String` | 'server' | 部署类型,可选值:`oss` \| `cos` \| `server` |
| **alioss** | `Object` | null | 阿里云OSS的配置,参考配置概览 |
| **cos** | `Object` | null | 腾讯云COS的配置,参考配置概览 |
| **server** | `Object` | null | 服务器的配置,参考配置概览 |
| **server** | `Object` | null | 服务器的配置,参考配置概览 |

-----------

0 comments on commit 64e8d71

Please sign in to comment.