Update types/mongooseoptions.d.ts

Co-authored-by: hasezoey <hasezoey@gmail.com>
Automattic · Jul 20, 2022 · 85f18f8 · 85f18f8
1 parent 80d1aaa
commit 85f18f8
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/types/mongooseoptions.d.ts b/types/mongooseoptions.d.ts
@@ -79,7 +79,10 @@ declare module 'mongoose' {
     | stream.Writable
     | ((collectionName: string, methodName: string, ...methodArgs: any[]) => void);
 
-    /** Defaults to `true`. If `true`, adds a `id` virtual to all schemas by default. */
+    /** 
+     * If `true`, adds a `id` virtual to all schemas unless overwritten on a per-schema basis. 
+     * @defaultValue true
+     */
     id?: boolean;
 
     /**