Merge pull request #12465 from zrosenbauer/chore/add-sanitizeFilter-t…

…o-types

chore: Add `sanitizeFilter` to types

test/types/sanitizeFilter.test.ts

@@ -0,0 +1,7 @@
+import { FilterQuery, sanitizeFilter } from 'mongoose';
+import { expectType } from 'tsd';
+
+const data = { username: 'val', pwd: { $ne: null } };
+type Data = typeof data;
+
+expectType<FilterQuery<Data>>(sanitizeFilter<typeof data>(data));

types/index.d.ts

@@ -58,6 +58,12 @@ declare module 'mongoose' {
    */
   export function deleteModel(name: string | RegExp): Mongoose;
 
+  /**
+   * Sanitizes query filters against query selector injection attacks by wrapping
+   * any nested objects that have a property whose name starts with `$` in a `$eq`.
+   */
+  export function sanitizeFilter<T>(filter: FilterQuery<T>): FilterQuery<T>;
+
   /** Gets mongoose options */
   export function get<K extends keyof MongooseOptions>(key: K): MongooseOptions[K];