enforce non-null parameter to .eq

supabase · Aug 24, 2023 · fbeb24c · fbeb24c
1 parent be421d9
commit fbeb24c
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 2 deletions.
diff --git a/src/PostgrestFilterBuilder.ts b/src/PostgrestFilterBuilder.ts
@@ -31,8 +31,11 @@ export default class PostgrestFilterBuilder<
   Result,
   Relationships = unknown
 > extends PostgrestTransformBuilder<Schema, Row, Result, Relationships> {
-  eq<ColumnName extends string & keyof Row>(column: ColumnName, value: Row[ColumnName]): this
-  eq(column: string, value: unknown): this
+  eq<ColumnName extends string & keyof Row>(
+    column: ColumnName,
+    value: NonNullable<Row[ColumnName]>
+  ): this
+  eq<Value extends unknown>(column: string, value: NonNullable<Value>): this
   /**
    * Match only rows where `column` is equal to `value`.
    *

diff --git a/test/index.test-d.ts b/test/index.test-d.ts
@@ -11,6 +11,15 @@ const postgrest = new PostgrestClient<Database>(REST_URL)
   expectError(postgrest.from(42))
 }
 
+// test filters
+{
+  postgrest.from('users').select().eq('username', 'foo')
+  expectError(postgrest.from('users').select().eq('username', null))
+
+  const nullableVar = 'foo' as string | null
+  expectError(postgrest.from('users').select().eq('username', nullableVar))
+}
+
 // can override result type
 {
   const { data, error } = await postgrest