@univerjs/sheets-sort 0.6.1 → 0.6.2

package/lib/es/facade.js

@@ -21,7 +21,6 @@ u.extend(E);
 class w extends l {
   sort(o, e = !0) {
     const t = [{
-      // real column index should be colIndex - 1.
       colIndex: o,
       type: e ? s.ASC : s.DESC
     }], r = {

package/lib/types/facade/f-range.d.ts

@@ -9,16 +9,22 @@ export type SortColumnSpec = {
 export interface IFRangeSort {
     /**
      * Sorts the cells in the given range, by column(s) and order specified.
-     * @param {SortColumnSpec | SortColumnSpec[]} column The column index with order or an array of column indexes with order. The column index starts from 1.
-     * @returns The range itself for chaining.
+     * @param {SortColumnSpec | SortColumnSpec[]} column The column index with order or an array of column indexes with order. The range first column index is 0.
+     * @returns {FRange} The range itself for chaining.
      * @example
      * ```typescript
-     * const activeSpreadsheet = univerAPI.getActiveWorkbook();
-     * const activeSheet = activeSpreadsheet.getActiveSheet();
-     * const range = activeSheet.getRange(0, 0, 10, 10);
-     * range.sort(1); // Sorts the range by the first column in ascending order.
-     * range.sort({ column: 1, ascending: false }); // Sorts the range by the first column in descending order.
-     * range.sort([{ column: 1, ascending: false }, 2]); // Sorts the range by the first column in descending order and the second column in ascending order.
+     * const fWorkbook = univerAPI.getActiveWorkbook();
+     * const fWorksheet = fWorkbook.getActiveSheet();
+     * const fRange = fWorksheet.getRange('D1:G10');
+     *
+     * // Sorts the range by the first column in ascending order.
+     * fRange.sort(0);
+     *
+     * // Sorts the range by the first column in descending order.
+     * fRange.sort({ column: 0, ascending: false });
+     *
+     * // Sorts the range by the first column in descending order and the second column in ascending order.
+     * fRange.sort([{ column: 0, ascending: false }, 1]);
      * ```
      */
     sort(column: SortColumnSpec | SortColumnSpec[]): FRange;

package/lib/types/facade/f-worksheet.d.ts

@@ -6,7 +6,7 @@ export interface IFWorksheetSort {
     /**
      * Sort the worksheet by the specified column.
      * @param {number} colIndex The column index to sort by.
-     * @param {boolean} [asc=true] The sort order. `true` for ascending, `false` for descending.
+     * @param {boolean} [asc=true] The sort order. `true` for ascending, `false` for descending. The column A index is 0.
      * @returns {FWorksheet} The worksheet itself for chaining.
      * @example
      * ```typescript

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@univerjs/sheets-sort",
-  "version": "0.6.1",
+  "version": "0.6.2",
   "private": false,
   "description": "A library for sorting data in Univer Sheet",
   "author": "DreamNum <developer@univer.ai>",
@@ -53,15 +53,15 @@
     "lib"
   ],
   "dependencies": {
-    "@univerjs/core": "0.6.1",
-    "@univerjs/sheets": "0.6.1",
-    "@univerjs/engine-formula": "0.6.1"
+    "@univerjs/core": "0.6.2",
+    "@univerjs/engine-formula": "0.6.2",
+    "@univerjs/sheets": "0.6.2"
   },
   "devDependencies": {
     "typescript": "^5.7.3",
-    "vite": "^6.1.1",
-    "vitest": "^3.0.6",
-    "@univerjs-infra/shared": "0.6.1"
+    "vite": "^6.2.0",
+    "vitest": "^3.0.7",
+    "@univerjs-infra/shared": "0.6.2"
   },
   "scripts": {
     "test": "vitest run",