feat: Add _is_null filter in query helpers (#154)

poap-xyz · Dec 19, 2024 · eeb2fb0 · eeb2fb0
1 parent 12c0f67
commit eeb2fb0
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 1 deletion.
diff --git a/docs/pages/packages/utils/Queries.mdx b/docs/pages/packages/utils/Queries.mdx
@@ -79,6 +79,7 @@ The possible filters to create are:
 - `createInFilter`: if the field is contained in any of the given values.
 - `createNinFilter`: not contained in the given values.
 - `createBetweenFilter`: from and to values, mostly used for dates.
+- `createIsNullFilter`: to check if the field is null.
 
 ### Use of DOT notation
 

diff --git a/packages/utils/src/queries/filter.ts b/packages/utils/src/queries/filter.ts
@@ -10,6 +10,7 @@ import {
   LteFilter,
   NeqFilter,
   NinFilter,
+  IsNullFilter,
   Value,
 } from '../types/filter';
 import { ZERO_ADDRESS, DEAD_ADDRESS } from '../constants';
@@ -146,3 +147,10 @@ export function createBetweenFilter<V = Value>(
       )
     : {};
 }
+
+export function createIsNullFilter(
+  key: string,
+  value: boolean,
+): FieldFilter<IsNullFilter> {
+  return createField<IsNullFilter>(key, { _is_null: value });
+}
diff --git a/packages/utils/src/types/filter.ts b/packages/utils/src/types/filter.ts
@@ -36,6 +36,10 @@ export interface LteFilter<V = Value> {
   _lte: V;
 }
 
+export interface IsNullFilter {
+  _is_null: boolean;
+}
+
 export type AnyFilter = Partial<EqFilter> &
   Partial<NeqFilter> &
   Partial<LikeFilter> &
@@ -44,7 +48,8 @@ export type AnyFilter = Partial<EqFilter> &
   Partial<GtFilter> &
   Partial<GteFilter> &
   Partial<LtFilter> &
-  Partial<LteFilter>;
+  Partial<LteFilter> &
+  Partial<IsNullFilter>;
 
 export type FieldFilter<F = AnyFilter> = {
   [key: string]: FieldFilter<F> | F;