more documents

Author: kiwicopple

src/lib/storage/StorageApi.ts

@@ -299,7 +299,7 @@ export class StorageApi {
    * Lists all the files within a bucket.
    * @param bucketId The bucket which contains the files.
    * @param path The folder path.
-   * @param options Search options.
+   * @param options Search options, including `limit`, `offset`, and `sortBy`.
    */
   async listFiles(
     bucketId: string,

src/lib/storage/types.ts

@@ -22,10 +22,14 @@ export interface SortBy {
   column?: string
   order?: string
 }
-
 export interface SearchOptions {
+  /** The number of files you want to be returned. */
   limit?: number
+
+  /** The starting position. */
   offset?: number
+
+  /** The column to sort by. Can be any column inside a FileObject. */
   sortBy?: SortBy
 }