from.list()

from.list()用于列出存储桶内的所有文件。

需要RLS策略权限:

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

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

案例教程

案例1 （在存储桶中列出文件）#

1                                                                                 
2const { data, error } = await supabase
3.storage
4.from('avatars')
5.list('folder', {
6  limit: 100,
7  offset: 0,
8  sortBy: { column: 'name', order: 'asc' },
9})

案例2 （在存储桶中搜索文件）#

1                                                                                 
2const { data, error } = await supabase
3.storage
4.from('avatars')
5.list('folder', {
6  limit: 100,
7  offset: 0,
8  sortBy: { column: 'name', order: 'asc' },
9  search: 'jon'
10})

参数说明

  • 路径（path）[可选参数]
    string类型

    文件夹路径。

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

      特性

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

      你希望返回的文件数量。

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

      起始位置。

    • search[可选参数]
      string类型

      按照搜索字符串筛选文件的条件。

    • sortBy[可选参数]
      SortBy类型

      要排序的列。可以是FileObject中的任何列。

        特性

      • 列（column）[可选参数]
        string类型

      • order[可选参数]
        string类型

  • parameters[可选参数]
    FetchParameters类型

      特性

    • signal[可选参数]
      AbortSignal类型

      传入一个AbortController的信号来取消请求。