dima/supabase
1
0 Fork 0
mirror of https://github.com/supabase/supabase.git synced 2026-10-05 17:35:10 +03:00
Code Issues Packages Projects Releases Wiki Activity

chore: update docs with new helper types. (#19163)

Browse Source 
* chore: update docs with new helper types.

* chore: update naming.
This commit is contained in:
Thor 雷神 Schaeff authored and GitHub committed 2023-12-01 08:01:21 +00:00
1 parent 8467b847c5
commit 3a41744af8
3 files changed
+33 -63
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

apps/docs/docs/ref/javascript/typescript-support.mdx
+15 -25
View File
@@ -158,21 +158,13 @@ const { data } = await supabase.from('countries').select().returns<MyType>()
<RefSubLayout.EducationRow>
<RefSubLayout.Details>
It's convenient to have shorthands for your most-used types.
The generated types provide shorthands for accessing tables and enums.
</RefSubLayout.Details>
<RefSubLayout.Examples>
```ts ./database.types.ts
import { Database } from "./database-generated.types.ts";
export type { Database } from "./database-generated.types.ts";
export type Tables<T extends keyof Database['public']['Tables']> = Database['public']['Tables'][T]['Row']
export type Enums<T extends keyof Database['public']['Enums']> = Database['public']['Enums'][T]
// etc.
```
```ts ./index.ts
import { Database, Tables } from "./database.types.ts";
import { Database, Tables, Enums } from "./database.types.ts";
// Before 😕
let movie: Database['public']['Tables']['movies']['Row'] = // ...
@@ -210,23 +202,21 @@ const { data } = await supabase.from('countries').select().returns<MyType>()
</RefSubLayout.Details>
<RefSubLayout.Examples>
```ts
import { PostgrestError } from '@supabase/supabase-js'
export type DbResult<T> = T extends PromiseLike<infer U> ? U : never
export type DbResultOk<T> = T extends PromiseLike<{ data: infer U }> ? Exclude<U, null> : never
export type DbResultErr = PostgrestError
```
```ts
const countriesWithCitiesQuery = supabase.from("countries").select(
`
id,
name,
cities ( id, name )
`
);
type CountriesWithCities = DbResultOk<typeof countriesWithCitiesQuery>;
import { QueryResult, QueryData, QueryError } from '@supabase/supabase-js'
const countriesWithCitiesQuery = supabase
.from("countries")
.select(`
id,
name,
cities (
id,
name
)
`);
type CountriesWithCities = QueryData<typeof countriesWithCitiesQuery>;
const { data, error } = await countriesWithCitiesQuery;
if (error) throw error;
apps/docs/pages/guides/api/joins-and-nesting.mdx
+8 -13
View File
@@ -113,22 +113,17 @@ create table cities (
We can get the nested `CountriesWithCities` type like this:
```ts
import { PostgrestError } from '@supabase/supabase-js'
import { QueryResult, QueryData, QueryError } from '@supabase/supabase-js'
export type DbResult<T> = T extends PromiseLike<infer U> ? U : never
export type DbResultOk<T> = T extends PromiseLike<{ data: infer U }> ? Exclude<U, null> : never
export type DbResultErr = PostgrestError
```
```ts
const countriesWithCitiesQuery = supabase.from('countries').select(
`
const countriesWithCitiesQuery = supabase.from('countries').select(`
id,
name,
cities ( id, name )
`
)
type CountriesWithCities = DbResultOk<typeof countriesWithCitiesQuery>
cities (
id,
name
)
`)
type CountriesWithCities = QueryData<typeof countriesWithCitiesQuery>
const { data, error } = await countriesWithCitiesQuery
if (error) throw error
apps/docs/pages/guides/api/rest/generating-types.mdx
+10 -25
View File
@@ -129,20 +129,10 @@ const { data } = await supabase.from('countries').select().returns<MyType>()
### Type shorthands
It's convenient to have shorthands for your most-used types.
```ts ./database.types.ts
import { Database } from './database-generated.types.ts'
export type { Database } from './database-generated.types.ts'
export type Tables<T extends keyof Database['public']['Tables']> =
Database['public']['Tables'][T]['Row']
export type Enums<T extends keyof Database['public']['Enums']> = Database['public']['Enums'][T]
// etc.
```
The generated types provide shorthands for accessing tables and enums.
```ts ./index.ts
import { Database, Tables } from "./database.types.ts";
import { Database, Tables, Enums } from "./database.types.ts";
// Before 😕
let movie: Database['public']['Tables']['movies']['Row'] = // ...
@@ -175,22 +165,17 @@ create table cities (
We can get the nested `CountriesWithCities` type like this:
```ts
import { PostgrestError } from '@supabase/supabase-js'
import { QueryResult, QueryData, QueryError } from '@supabase/supabase-js'
export type DbResult<T> = T extends PromiseLike<infer U> ? U : never
export type DbResultOk<T> = T extends PromiseLike<{ data: infer U }> ? Exclude<U, null> : never
export type DbResultErr = PostgrestError
```
```ts
const countriesWithCitiesQuery = supabase.from('countries').select(
`
const countriesWithCitiesQuery = supabase.from('countries').select(`
id,
name,
cities ( id, name )
`
)
type CountriesWithCities = DbResultOk<typeof countriesWithCitiesQuery>
cities (
id,
name
)
`)
type CountriesWithCities = QueryData<typeof countriesWithCitiesQuery>
const { data, error } = await countriesWithCitiesQuery
if (error) throw error