docs: improve tsdoc for the range() method (#439)

* Documentation improvements for the `range()` method These updates are based on feedback in issue #15222 (supabase/supabase#15222) The original docs state that "range" takes a starting index and ending index and returns the values between them. This implies that it's using the primary ID. But it actually works more like limit + offset. --------- Co-authored-by: Bobbie Soedirgo <[email protected]>
supabase · Jun 23, 2023 · cb94a8d · cb94a8d
1 parent aeb2ce9
commit cb94a8d
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/src/PostgrestTransformBuilder.ts b/src/PostgrestTransformBuilder.ts
@@ -101,7 +101,11 @@ export default class PostgrestTransformBuilder<
   }
 
   /**
-   * Limit the query result by `from` and `to` inclusively.
+   * Limit the query result by starting at an offset (`from`) and ending at the offset (`from + to`).
+   * Only records within this range are returned.
+   * This respects the query order and if there is no order clause the range could behave unexpectedly.
+   * The `from` and `to` values are 0-based and inclusive: `range(1, 3)` will include the second, third
+   * and fourth rows of the query.
    *
    * @param from - The starting index from which to limit the result
    * @param to - The last index to which to limit the result