Browse Source

chore: updates README.md

e22m4u 2 years ago
parent
commit
d864e11d75
1 changed files with 20 additions and 0 deletions
  1. 20 0
      README.md

+ 20 - 0
README.md

@@ -245,6 +245,26 @@ console.log(person);
 // }
 ```
 
+Использование параметра `filter`
+
+```js
+// второй параметр опционально принимает объект
+// с настройками возвращаемого результата
+const result = await rep.create(data, {
+  // "fields" - если определено, то возвращаемый
+  // документ будут включать только указанные поля
+  fields: 'name',
+  fields: ['name', 'age'],
+
+  // "include" - включить в результат связанные
+  // документы по имени связи, которая определена
+  // в модели данного репозитория
+  include: 'son',
+  include: {son: 'hobbies'},
+  include: ['son', 'daughter'],
+});
+```
+
 #### replaceById(id, data, filter = undefined)
 
 Заменяет существующий документ.