Skip to content

deploy.tcb

部署本地静态资源到腾讯云 CloudBase 静态网站托管。

前置依赖

参数名类型说明
deps.existsSyncFileSystem['existsSync']校验本地目录
deps.initCloudBaseManager['init']@cloudbase/manager-node
deps.log / errorConsole日志
deps.getSecret密钥获取SecretId/Key

环境要求

  • Node.js
  • @cloudbase/manager-node

函数签名

typescript
function deployToTCB(
  options: DeployOptions,
  deps: DeployTCBDeps,
): Promise<DeployResult>

参数

参数名类型必填说明
options.localPathstring待上传目录(如 dist
options.envIdstringCloudBase 环境 ID
options.cloudPathstring云端路径前缀,默认 /
options.secretTypeSecretType密钥类型
options.showProgressboolean是否输出进度

返回值

类型说明
DeployResult{ success, error?, uploadResult? }

工作原理

  1. 验证本地路径与腾讯云密钥。
  2. deps.init({ secretId, secretKey }) 创建管理端实例。
  3. 调用静态托管上传 API 将 localPath 同步到 cloudPath
  4. 失败返回 error 文案,不抛出到调用方外层。

异常

见返回值 error 字段;内部 catch 后转为 success: false