[types] SortedRowIdsArgs

Author: jamesgpearce

src/@types/store/docs.js

@@ -526,6 +526,50 @@
  * @since v1.0.0
  */
 /// DoRollback
+/**
+ * The SortedRowIdsArgs type describes the arguments used to sort Row Ids using
+ * the getSortedRowIds method.
+ *
+ * It's an object containing the Id of the Table in the Store, and optional
+ * `cellId`, `descending`, `offset`, and `limit` parameters. See the
+ * getSortedRowIds method for specific examples.
+ * @category Store
+ * @since v6.1.0
+ */
+/// SortedRowIdsArgs
+{
+  /**
+   * The Id of the Table in the Store, required.
+   * @category Argument
+   * @since v6.1.0
+   */
+  /// SortedRowIdsArgs.tableId
+  /**
+   * The optional Id of the Cell whose values are used for the sorting, defaults
+   * to sorting by the Row Id itself.
+   * @category Argument
+   * @since v6.1.0
+   */
+  /// SortedRowIdsArgs.cellId
+  /**
+   * Whether the sorting should be in descending order, defaulting to false.
+   * @category Argument
+   * @since v6.1.0
+   */
+  /// SortedRowIdsArgs.descending
+  /**
+   * The number of Row Ids to skip for pagination purposes, defaulting to 0.
+   * @category Argument
+   * @since v6.1.0
+   */
+  /// SortedRowIdsArgs.offset
+  /**
+   * The maximum number of Row Ids to return, defaulting to all.
+   * @category Argument
+   * @since v6.1.0
+   */
+  /// SortedRowIdsArgs.limit
+}
 /**
  * The TransactionListener type describes a function that is used to listen to
  * the completion of a transaction for the Store.
@@ -1977,8 +2021,9 @@
   /**
    * When called with one object argument, the getSortedRowIds method
    * destructures it to make it easier to skip optional parameters.
-   * @param args An object containing the Id of the Table in the Store, and
-   * optional `cellId`, `descending`, `offset`, and `limit` parameters.
+   * @param args A SortedRowIdsArgs object containing the Id of the Table in the
+   * Store, and optional `cellId`, `descending`, `offset`, and `limit`
+   * parameters.
    * @returns An array of the sorted Ids of appropriate Rows in the Table.
    * @example
    * This example retrieves the first sorted Row Id in a Table.

src/@types/store/index.d.ts

@@ -115,6 +115,20 @@ export type ChangedValueIds = {[valueId: Id]: IdAddedOrRemoved};
 /// DoRollback
 export type DoRollback = (store: Store) => boolean;
 
+/// SortedRowIdsArgs
+export type SortedRowIdsArgs = {
+  /// SortedRowIdsArgs.tableId
+  tableId: Id;
+  /// SortedRowIdsArgs.cellId
+  cellId?: Id;
+  /// SortedRowIdsArgs.descending
+  descending?: boolean;
+  /// SortedRowIdsArgs.offset
+  offset?: number;
+  /// SortedRowIdsArgs.limit
+  limit?: number;
+};
+
 /// TransactionListener
 export type TransactionListener<Store extends StoreAlias = StoreAlias> = (
   store: Store,
@@ -445,13 +459,7 @@ export interface Store {
   ): Ids;
 
   /// Store.getSortedRowIds.2
-  getSortedRowIds(args: {
-    tableId: Id;
-    cellId?: Id;
-    descending?: boolean;
-    offset?: number;
-    limit?: number;
-  }): Ids;
+  getSortedRowIds(args: SortedRowIdsArgs): Ids;
 
   /// Store.getRow
   getRow(tableId: Id, rowId: Id): Row;

src/@types/store/with-schemas/index.d.ts

@@ -295,6 +295,23 @@ export type DoRollback<Schemas extends OptionalSchemas> = (
   store: Store<Schemas>,
 ) => boolean;
 
+/// SortedRowIdsArgs
+export type SortedRowIdsArgs<
+  Schema extends OptionalTablesSchema,
+  TableId extends TableIdFromSchema<Schema> = TableIdFromSchema<Schema>,
+> = {
+  /// SortedRowIdsArgs.tableId
+  tableId: TableId;
+  /// SortedRowIdsArgs.cellId
+  cellId?: CellIdFromSchema<Schema, TableId>;
+  /// SortedRowIdsArgs.descending
+  descending?: boolean;
+  /// SortedRowIdsArgs.offset
+  offset?: number;
+  /// SortedRowIdsArgs.limit
+  limit?: number;
+};
+
 /// TransactionListener
 export type TransactionListener<
   Schemas extends OptionalSchemas,
@@ -942,13 +959,9 @@ export interface Store<in out Schemas extends OptionalSchemas> {
   ): Ids;
 
   /// Store.getSortedRowIds.2
-  getSortedRowIds<TableId extends TableIdFromSchema<Schemas[0]>>(args: {
-    tableId: TableId;
-    cellId?: CellIdFromSchema<Schemas[0], TableId>;
-    descending?: boolean;
-    offset?: number;
-    limit?: number;
-  }): Ids;
+  getSortedRowIds<TableId extends TableIdFromSchema<Schemas[0]>>(
+    args: SortedRowIdsArgs<Schemas[0], TableId>,
+  ): Ids;
 
   /// Store.getRow
   getRow<TableId extends TableIdFromSchema<Schemas[0]>>(

src/store/index.ts

@@ -16,6 +16,7 @@ import type {
   MapCell,
   Row,
   RowCallback,
+  SortedRowIdsArgs,
   SortedRowIdsListener,
   Store,
   StoreListenerStats,
@@ -1012,15 +1013,7 @@ export const createStore: typeof createStoreDecl = (): Store => {
     mapKeys(mapGet(tablesMap, id(tableId)));
 
   const getSortedRowIds = (
-    tableId:
-      | Id
-      | {
-          tableId: Id;
-          cellId?: Id;
-          descending?: boolean;
-          offset?: number;
-          limit?: number;
-        },
+    tableId: Id | SortedRowIdsArgs,
     cellId?: Id,
     descending?: boolean,
     offset = 0,