Feat/mod operator (#36)

* Feat: Add $mod operator

* Add more test

---------

Co-authored-by: Nicolás San Martín <nicolassanmar@gmail.com>

src/types/filter.assert.ts

@@ -130,6 +130,14 @@ ta.assert<
 // Test $in operator
 ta.assert<ta.Extends<{ a: { $in: number[] } }, TsFilter<{ a: number }>>>()
 
+// test $mod operator
+ta.assert<
+  ta.Extends<{ a: { $mod: [number, number] } }, TsFilter<{ a: number }>>
+>()
+ta.assert<
+  ta.Not<ta.Extends<{ a: { $mod: [3, 5] } }, TsFilter<{ a: string }>>>
+>()
+
 // Test FlattenPaths / FlattenType
 type Example = {
   a: number
@@ -179,6 +187,9 @@ ta.assert<ta.Extends<{ $in: number[] }, FilterType<Example, 'a'>>>()
 ta.assert<
   ta.Extends<{ $and: [{ $lt: 2 }, { $gt: 0 }] }, FilterType<Example, 'a'>>
 >()
+ta.assert<ta.Extends<{ $mod: [2, 0] }, FilterType<Example, 'a'>>>()
+ta.assert<ta.Not<ta.Extends<{ $mod: [2, 0] }, FilterType<Example, 'b.c'>>>>()
+ta.assert<ta.Not<ta.Extends<{ $mod: [2, 0] }, FilterType<Example, 'b.d'>>>>()
 
 // These use to be wrong, keeping as regression testing
 ta.assert<ta.Not<ta.Extends<{ a: 2 }, WithOperator<{ a: number }[]>>>>()

src/types/filter.ts

@@ -91,6 +91,12 @@ export type WithRecordOperator<
     }
   : {}
 
+export type WithModulusOperator<Field> = Field extends number
+  ? {
+      $mod?: [number, number]
+    }
+  : {}
+
 export type WithOperator<Field, IndexType extends number = 0> =
   | RecurPartial<Field>
   | WithNegatableOperator<
@@ -102,7 +108,8 @@ export type WithOperator<Field, IndexType extends number = 0> =
         WithEqualityOperator<Field> &
         WithArrayOperator<Field> &
         WithGeoSpatialQueryOperator<Field> &
-        WithBitwiseOperator<Field>
+        WithBitwiseOperator<Field> &
+        WithModulusOperator<Field>
     >
 
 /**