chore: clean up docs

Author: tmm

README.md

@@ -33,18 +33,19 @@ const App = () => (
 )
 ```
 
-Now every component inside and under the `Provider` can use the Supabase client:
+Now every component inside and under the `Provider` can use the Supabase client and hooks:
 
 ```js
-import { useSelect } from 'react-supabase'
+import { useRealtime } from 'react-supabase'
 
 const Todos = () => {
-  const [result, reexecuteSelect] = useSelect('todos')
+  const [result, reexecute] = useRealtime('todos')
 
   const { data, fetching, error } = result
 
   if (fetching) return <p>Loading...</p>
   if (error) return <p>Oh no... {error.message}</p>
+
   return (
     <ul>
       {data.map((todo) => (

docs/pages/documentation/data/use-delete.md

@@ -6,7 +6,7 @@ Performs DELETE on table.
 import { useDelete } from 'react-supabase'
 
 function Page() {
-  const [{ count, data, error, fetching }, deleteTodos] = useDelete('todos')
+  const [{ count, data, error, fetching }, execute] = useDelete('todos')
 
   async function onClickDelete(id) {
     const { count, data, error } = await deleteTodos(
@@ -25,7 +25,7 @@ Throws error during execute if a filter is not passed during hook initialization
 During hook initialization:
 
 ```js
-const [{ count, data, error, fetching }, deleteTodos] = useDelete('todos', {
+const [{ count, data, error, fetching }, execute] = useDelete('todos', {
   filter: (query) => query.eq('status', 'completed'),
   options: {
     returning: 'represenation',
@@ -37,11 +37,8 @@ const [{ count, data, error, fetching }, deleteTodos] = useDelete('todos', {
 Or execute function:
 
 ```js
-const { count, data, error } = await deleteTodos(
-  (query) => query.eq('id', id),
-  {
-    returning: 'minimal',
-    count: 'estimated',
-  },
-)
+const { count, data, error } = await execute((query) => query.eq('id', id), {
+  returning: 'minimal',
+  count: 'estimated',
+})
 ```

docs/pages/documentation/data/use-insert.md

@@ -6,7 +6,7 @@ Performs INSERT into table.
 import { useInsert } from 'react-supabase'
 
 function Page() {
-  const [{ count, data, error, fetching }, insertTodos] = useInsert('todos')
+  const [{ count, data, error, fetching }, execute] = useInsert('todos')
 
   async function onClickInsert(name) {
     const { count, data, error } = await insertTodos({
@@ -23,7 +23,7 @@ function Page() {
 During hook initialization:
 
 ```js
-const [{ count, data, error, fetching }, insertTodos] = useInsert('todos', {
+const [{ count, data, error, fetching }, execute] = useInsert('todos', {
   options: {
     returning: 'represenation',
     count: 'exact',
@@ -34,7 +34,7 @@ const [{ count, data, error, fetching }, insertTodos] = useInsert('todos', {
 Or execute function:
 
 ```js
-const { count, data, error } = await insertTodos(
+const { count, data, error } = await execute(
   { name: 'Buy more cheese' },
   {
     count: 'estimated',

docs/pages/documentation/data/use-select.md

@@ -6,7 +6,7 @@ Performs vertical filtering with SELECT.
 import { useSelect } from 'react-supabase'
 
 function Page() {
-  const [{ count, data, error, fetching }, selectTodos] = useSelect('todos')
+  const [{ count, data, error, fetching }, reexecute] = useSelect('todos')
 
   if (error) return <div>{error.message}</div>
   if (fetching) return <div>Loading todos</div>
@@ -21,7 +21,7 @@ function Page() {
 During hook initialization:
 
 ```js
-const [{ count, data, error, fetching }, selectTodos] = useSelect('todos', {
+const [{ count, data, error, fetching }, reexecute] = useSelect('todos', {
   columns: 'id, name, description',
   filter: (query) => query.eq('status', 'completed'),
   options: {
@@ -47,7 +47,7 @@ function Page() {
     (query) => query.eq('status', status),
     [status],
   )
-  const [{ data }] = useSelect('todos', { filter })
+  const [result, reexecute] = useSelect('todos', { filter })
 
   return ...
 }

docs/pages/documentation/data/use-update.md

@@ -6,10 +6,10 @@ Performs UPDATE on table.
 import { useUpdate } from 'react-supabase'
 
 function Page() {
-  const [{ count, data, error, fetching }, updateTodos] = useUpdate('todos')
+  const [{ count, data, error, fetching }, execute] = useUpdate('todos')
 
   async function onClickMarkAllComplete() {
-    const { count, data, error } = await updateTodos(
+    const { count, data, error } = await execute(
       { completed: true },
       (query) => query.eq('completed', false),
     )
@@ -26,7 +26,7 @@ Throws error during execute if a filter is not passed during hook initialization
 During hook initialization:
 
 ```js
-const [{ count, data, error, fetching }, updateTodos] = useUpdate('todos', {
+const [{ count, data, error, fetching }, execute] = useUpdate('todos', {
   filter: (query) => query.eq('completed', false),
   options: {
     returning: 'represenation',
@@ -38,7 +38,7 @@ const [{ count, data, error, fetching }, updateTodos] = useUpdate('todos', {
 Or execute function:
 
 ```js
-const { count, data, error } = await updateTodos(
+const { count, data, error } = await execute(
   { completed: true },
   (query) => query.eq('completed', false),
   {

docs/pages/documentation/realtime/use-realtime.md

@@ -6,7 +6,7 @@ Fetch table and listen for changes.
 import { useRealtime } from 'react-supabase'
 
 function Page() {
-  const [{ data, error, fetching }, refresh] = useRealtime('todos')
+  const [{ data, error, fetching }, reexecute] = useRealtime('todos')
 
   return ...
 }
@@ -22,7 +22,7 @@ When using your own compare function, you typically want to compare unique value
 import { useRealtime } from 'react-supabase'
 
 function Page() {
-  const [{ data, error, fetching }, refresh] = useRealtime(
+  const [result, reexecute] = useRealtime(
     'todos',
     (data, payload) => data.username === payload.username,
   )

docs/pages/getting-started.md

@@ -25,18 +25,19 @@ const App = () => (
 )
 ```
 
-Now every component inside and under the `Provider` can use the Supabase client (`useClient`) and related hooks (`useSelect`, `useSignIn`, `useSubscription`, etc.):
+Now every component inside and under the `Provider` can use the Supabase client and hooks:
 
 ```js
-import { useSelect } from 'react-supabase'
+import { useRealtime } from 'react-supabase'
 
 const Todos = () => {
-  const [result, reexecuteSelect] = useSelect('todos')
+  const [result, reexecute] = useRealtime('todos')
 
   const { data, fetching, error } = result
 
   if (fetching) return <p>Loading...</p>
   if (error) return <p>Oh no... {error.message}</p>
+
   return (
     <ul>
       {data.map((todo) => (

docs/pages/recipes/use-auth.md

@@ -34,7 +34,7 @@ import { AuthContext } from 'path/to/auth/context'
 
 export function useAuth() {
   const context = useContext(AuthContext)
-  if (context === undefined) {
+  if (context === undefined)
     throw Error('useAuth must be used within AuthProvider')
   return context
 }