Skip to main content

deleteSite()

从您的S3存储桶中删除一个 Remotion 项目。

每个项目位于您的 S3 存储桶的 sites/ 子目录中。调用此函数相当于删除 sites/ 子目录中所有文件。

示例​

获取所有站点并删除它们。

ts
import { AwsRegion, deleteSite, getSites } from "@remotion/lambda";
 
const region: AwsRegion = "eu-central-1";
 
const { sites } = await getSites({
  region,
});
 
for (const site of sites) {
  await deleteSite({
    bucketName: site.bucketName,
    siteName: site.id,
    region,
  });
  console.log(`Site ${site.id} deleted.`);
}
ts
import { AwsRegion, deleteSite, getSites } from "@remotion/lambda";
 
const region: AwsRegion = "eu-central-1";
 
const { sites } = await getSites({
  region,
});
 
for (const site of sites) {
  await deleteSite({
    bucketName: site.bucketName,
    siteName: site.id,
    region,
  });
  console.log(`Site ${site.id} deleted.`);
}

参数​

一个具有以下属性的对象：

region​

string

项目所在的 AWS 区域。

bucketName​

string

您的站点所在的 S3 存储桶的名称。

siteName​

string

要删除的项目的唯一 ID。

forcePathStyle?v4.0.202​

将 forcePathStyle 传递给 AWS S3 客户端。如果您不知道这是什么，您可能不需要它。

返回值​

一个解析为具有以下属性的对象的 Promise：

totalSizeInBytes​

number

通过删除项目释放的空间量。

参见​