Skip to content

引入

ts
import { purgeUrlCache, uploadCOSFileAndPurgeUrlCache } from 't-comm';

// 不支持 tree-shaking 的项目
import { purgeUrlCache, uploadCOSFileAndPurgeUrlCache} from 't-comm/lib/tencent-cloud/cdn/index';

// 只支持 ESM 的项目
import { purgeUrlCache, uploadCOSFileAndPurgeUrlCache} from 't-comm/es/tencent-cloud/cdn/index';

purgeUrlCache(config)

描述:刷新腾讯云 CDN URL 缓存 提交 URL 刷新请求,使 CDN 节点上的缓存内容失效

参数

参数名类型默认值描述
configobject配置信息
config.secretIdstring腾讯云 secretId
config.secretKeystring腾讯云 secretKey
[config.area]string"'mainland'"刷新区域,默认为中国大陆
config.urlsArray<string>需要刷新的 URL 列表

返回: Promise.<any>

刷新结果

示例

ts
await purgeUrlCache({
  secretId: 'xxx',
  secretKey: 'xxx',
  urls: ['https://cdn.example.com/file1.js', 'https://cdn.example.com/file2.css'],
});

uploadCOSFileAndPurgeUrlCache(config)

描述:上传文件到 COS 并刷新 CDN 缓存(一体化操作) 先上传文件到 COS,然后自动刷新对应的 CDN URL 缓存,支持 CDN 和 EdgeOne 两种刷新方式

参数

参数名类型默认值描述
configobject配置信息
config.secretIdstring腾讯云 secretId
config.secretKeystring腾讯云 secretKey
config.bucketstringCOS bucket
config.regionstringCOS region
config.filesArray<object>文件列表,每项包含 key、path、url
[config.area]string"&#x27;mainland&#x27;"CDN 刷新区域
[config.useEO]boolean是否使用 EdgeOne 刷新(默认使用 CDN)
[config.eoOptions]objectEdgeOne 刷新配置

返回: Promise.<{uploadResult: any, purgeResult: any, code: (1\|2)}>

code=2 表示上传和刷新均成功,code=1 表示上传成功但刷新失败

示例

ts
const result = await uploadCOSFileAndPurgeUrlCache({
  secretId: 'xxx',
  secretKey: 'xxx',
  bucket: 'my-bucket-1250000000',
  region: 'ap-guangzhou',
  files: [{
    key: 'static/app.js',
    path: '/dist/app.js',
    url: 'https://cdn.example.com/static/app.js',
  }],
});