deploy.tcb
部署本地静态资源到腾讯云 CloudBase 静态网站托管。
前置依赖
| 参数名 | 类型 | 说明 |
|---|---|---|
deps.existsSync | FileSystem['existsSync'] | 校验本地目录 |
deps.init | CloudBaseManager['init'] | @cloudbase/manager-node |
deps.log / error | Console | 日志 |
deps.getSecret | 密钥获取 | SecretId/Key |
环境要求
- Node.js
@cloudbase/manager-node
函数签名
typescript
function deployToTCB(
options: DeployOptions,
deps: DeployTCBDeps,
): Promise<DeployResult>参数
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
options.localPath | string | 是 | 待上传目录(如 dist) |
options.envId | string | 是 | CloudBase 环境 ID |
options.cloudPath | string | 否 | 云端路径前缀,默认 / |
options.secretType | SecretType | 是 | 密钥类型 |
options.showProgress | boolean | 否 | 是否输出进度 |
返回值
| 类型 | 说明 |
|---|---|
DeployResult | { success, error?, uploadResult? } |
工作原理
- 验证本地路径与腾讯云密钥。
deps.init({ secretId, secretKey })创建管理端实例。- 调用静态托管上传 API 将
localPath同步到cloudPath。 - 失败返回 error 文案,不抛出到调用方外层。
异常
见返回值 error 字段;内部 catch 后转为 success: false。