feat: add query result type helpers.

supabase · Nov 23, 2023 · 31eb0ff · 31eb0ff
1 parent 3bc5723
commit 31eb0ff
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 1 deletion.
diff --git a/src/index.ts b/src/index.ts
@@ -17,7 +17,12 @@ export {
 } from '@supabase/functions-js'
 export * from '@supabase/realtime-js'
 export { default as SupabaseClient } from './SupabaseClient'
-export type { SupabaseClientOptions } from './lib/types'
+export type {
+  SupabaseClientOptions,
+  QueryResult,
+  QueryResultData,
+  QueryResultError,
+} from './lib/types'
 
 /**
  * Creates a new Supabase Client.

diff --git a/src/lib/types.ts b/src/lib/types.ts
@@ -1,5 +1,6 @@
 import { GoTrueClient } from '@supabase/gotrue-js'
 import { RealtimeClientOptions } from '@supabase/realtime-js'
+import { PostgrestError } from '@supabase/postgrest-js'
 
 type GoTrueClientOptions = ConstructorParameters<typeof GoTrueClient>[0]
 
@@ -95,3 +96,10 @@ export type GenericSchema = {
   Views: Record<string, GenericView>
   Functions: Record<string, GenericFunction>
 }
+
+/**
+ * Helper types for query results.
+ */
+export type QueryResult<T> = T extends PromiseLike<infer U> ? U : never
+export type QueryResultData<T> = T extends PromiseLike<{ data: infer U }> ? Exclude<U, null> : never
+export type QueryResultError = PostgrestError