chore: address pr comments

Author: gkampitakis

src/collections/backup/client.ts

@@ -28,6 +28,7 @@ import {
   BackupReturn,
   BackupStatusArgs,
   BackupStatusReturn,
+  ListBackupOptions,
 } from './types.js';
 
 export const backup = (connection: Connection): Backup => {
@@ -205,9 +206,9 @@ export const backup = (connection: Connection): Backup => {
           }
         : parseResponse(res);
     },
-    list: (backend: Backend, sortAscending?: boolean): Promise<BackupReturn[]> => {
+    list: (backend: Backend, opts?: ListBackupOptions): Promise<BackupReturn[]> => {
       let url = `/backups/${backend}`;
-      if (sortAscending) {
+      if (opts?.startedAtAsc) {
         url += '?order=asc';
       }
       return connection.get<BackupReturn[]>(url);
@@ -265,8 +266,8 @@ export interface Backup {
   /** List existing backups (completed and in-progress) created in a given backend.
    *
    * @param {Backend} backend Backend whence to list backups.
-   * @param {sortAscending} [boolean] Sort list of backups in ascending order based on creation time. Default is descending order.
+   * @param {ListBackupOptions} [opts] The options available when listing backups.
    * @returns {Promise<BackupReturn[]>} The response from Weaviate.
-   * */
-  list(backend: Backend, sortAscending?: boolean): Promise<BackupReturn[]>;
+   */
+  list(backend: Backend, opts?: ListBackupOptions): Promise<BackupReturn[]>;
 }

src/collections/backup/integration.test.ts

@@ -247,7 +247,7 @@ describe('Integration testing of backups', () => {
       }
 
       const sortAscending = true;
-      const gotBackups = await client.backup.list('filesystem', sortAscending);
+      const gotBackups = await client.backup.list('filesystem', { startedAtAsc: sortAscending });
 
       // There may be other backups created in other tests;
       expect(gotBackups.length).toBeGreaterThanOrEqual(wantBackups.length);

src/collections/backup/types.ts

@@ -78,3 +78,8 @@ export type BackupCancelArgs = {
   /** The backend to use for the backup. */
   backend: Backend;
 };
+
+/** The options available when listing backups. */
+export type ListBackupOptions = {
+  startedAtAsc?: boolean;
+};