#270 Docs: adding @prop options _id

szokodiakos · Jun 6, 2019 · 795b4ab · 795b4ab
1 parent 6a52a02
commit 795b4ab
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -235,6 +235,15 @@ nickName?: string;
     @prop({ default: 'Nick' })
     nickName?: string;
     ```
+    
+  - `_id`: When false, no \_id is added to the subdocument
+
+    ```typescript
+    class Car extends Typegoose {}
+
+    @prop({ _id: false })
+    car?: Car;
+    ```
 
   - `ref`: By adding the `ref` option with another Typegoose class as value, a Mongoose reference property will be created. The type of the property on the Typegoose extending class should be `Ref<T>` (see Types section).