types(connection): add missing sanitizeFilter option

Automattic · Oct 20, 2024 · 57b38f8 · 57b38f8
1 parent 830b010
commit 57b38f8
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/types/connection.d.ts b/types/connection.d.ts
@@ -50,6 +50,12 @@ declare module 'mongoose' {
  autoIndex?: boolean;
  /** Set to `false` to disable Mongoose automatically calling `createCollection()` on every model created on this connection. */
  autoCreate?: boolean;
+ /**
+ * Sanitizes query filters against [query selector injection attacks](
+ * https://thecodebarbarian.com/2014/09/04/defending-against-query-selector-injection-attacks.html
+ * ) by wrapping any nested objects that have a property whose name starts with $ in a $eq.
+ */
+ sanitizeFilter?: boolean;
  }
 
  class Connection extends events.EventEmitter implements SessionStarter {