创建一个签名的URL。使用签名的URL在固定时间内分享一个文件。

需要RLS策略权限:

  • buckets表的权限: 无
  • objects表的权限：select权限

请参考存储指南中关于访问控制的工作方式。

案例教程

案例1 （创建一个带有签名的URL） 

                                                                                   
const { data, error } = await supabase
.storage
.from('avatars')
.createSignedUrl('folder/avatar1.png', 60)

案例2 （创建带有转换的签名URL） 

                                                                                   
const { data } = supabase
.storage
.from('avatars')
.createSignedUrl('folder/avatar1.png', 60, {
  transform: {
    width: 100,
    height: 100,
  }
})

案例3 （创建用于触发资源下载的签名URL） 

                                                                                   
const { data } = supabase
.storage
.from('avatars')
.createSignedUrl('folder/avatar1.png', 60, {
  download: true,
})

参数说明

  • 路径（path） [必要参数] string类型

    文件路径，包括当前文件名。例如 folder/image.png。

  • expiresIn [必要参数] number类型

    距离签名URL过期的秒数。例如，60表示一个有效期为1分钟的URL。

  • 选项（option） [可选参数] object类型

      特性

    • download [可选参数] string | boolean

      如果设置为 “true”，就会触发该文件的下载。如果你想用不同的文件名来触发下载，将此参数设置为文件名。

    • transform [可选参数] TransformOptions类型

      将资源提供给客户端之前对其进行转换。

        特性

      • format [必要参数] "origin"

        指定所请求图像的格式。当使用 ‘origin’ 时，我们强制格式与原始图像相同。当未传入此选项时，图像将被优化为现代图像格式，如 Webp。

      • height [可选参数] 数字类型

        图像的高度（以像素为单位）。

      • quality [可选参数] 数字类型

        设置返回图像的质量。取值范围为 20 到 100，其中 100 表示最高质量。默认为 80。

      • resize [可选参数] "cover" | "contain" | "fill"

        调整大小模式可以是 cover、contain 或 fill。默认为 cover。Cover 模式会根据原始图像的宽高比来调整图像的大小，并填充整个宽度和高度。 Contain 模式会根据原始图像的宽高比来调整图像的大小，并使整个图像适应指定的宽度和高度。Fill 模式会调整图像的大小以填充整个宽度和高度。如果对象的宽高比与指定的宽度和高度不匹配，图像将被拉伸以适应。

      • width [可选参数] 数字类型

        图像的宽度（以像素为单位）。