supabase / postgrest-js

Isomorphic JavaScript client for PostgREST.
https://supabase.com
MIT License
965 stars 129 forks source link

Documentation improvements for the `range()` method #439

Closed pangolingo closed 1 year ago

pangolingo commented 1 year ago

What kind of change does this PR introduce?

Docs update

What is the current behavior?

These updates are based on feedback in the Supabase repo's issue #15222 (https://github.com/supabase/supabase/issues/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.

What is the new behavior?

I've updated the docs to explain how it works in greater detail.

soedirgo commented 1 year ago

Thanks for the PR!

github-actions[bot] commented 12 months ago

:tada: This PR is included in version 1.7.2 :tada:

The release is available on:

Your semantic-release bot :package::rocket: