feat: typecheck table names in .from() (#528)

supabase · Mar 28, 2024 · 9dd41d9 · 9dd41d9
1 parent e26266a
commit 9dd41d9
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 1 deletion.
diff --git a/src/PostgrestClient.ts b/src/PostgrestClient.ts
@@ -63,7 +63,6 @@ export default class PostgrestClient<
   from<ViewName extends string & keyof Schema['Views'], View extends Schema['Views'][ViewName]>(
     relation: ViewName
   ): PostgrestQueryBuilder<Schema, View, ViewName>
-  from(relation: string): PostgrestQueryBuilder<Schema, any, any>
   /**
    * Perform a query on a table or a view.
    *

diff --git a/test/basic.ts b/test/basic.ts
@@ -629,6 +629,7 @@ test('throwOnError throws errors instead of returning them', async () => {
   let isErrorCaught = false
 
   try {
+    // @ts-expect-error: nonexistent table
     await postgrest.from('missing_table').select().throwOnError()
   } catch (error) {
     expect(error).toMatchInlineSnapshot(
@@ -642,6 +643,7 @@ test('throwOnError throws errors instead of returning them', async () => {
 
 test('throwOnError throws errors which include stack', async () => {
   try {
+    // @ts-expect-error: nonexistent table
     await postgrest.from('does_not_exist').select().throwOnError()
   } catch (err) {
     expect(err instanceof Error).toBe(true)

diff --git a/test/index.test-d.ts b/test/index.test-d.ts
@@ -10,6 +10,7 @@ const postgrest = new PostgrestClient<Database>(REST_URL)
 // table invalid type
 {
   expectError(postgrest.from(42))
+  expectError(postgrest.from('nonexistent_table'))
 }
 
 // `null` can't be used with `.eq()`