Browse Source

chore: updates README.md

e22m4u 2 years ago
parent
commit
e3ffaef60d
1 changed files with 23 additions and 31 deletions
  1. 23 31
      README.md

+ 23 - 31
README.md

@@ -342,39 +342,31 @@ console.log(result);
 #### find(filter = undefined)
 
 Поиск по коллекции репозитория.  
-Возвращает найденные документы в виде массива.  
+Возвращает найденные документы в виде массива.
 
 ```js
-// [
-//   {
-//     "id": 1,
-//     "title": "The Forgotten Ship"
-//   },
-//   {
-//     "id": 2,
-//     "title": "A Giant Bellows"
-//   },
-//   {
-//     "id": 3,
-//     "title": "Hundreds of bottles"
-//   }
-// ]
-const result = await rep.find();
-console.log(result);
-// [
-//   {
-//     "id": 1,
-//     "title": "The Forgotten Ship"
-//   },
-//   {
-//     "id": 2,
-//     "title": "A Giant Bellows"
-//   },
-//   {
-//     "id": 3,
-//     "title": "Hundreds of bottles"
-//   }
-// ]
+// вызов метода `find` без аргументов
+// запрашивает все документы коллекции
+const result1 = await rep.find();
+
+// первый аргумент может принимать объект
+// описывающий параметры выборки
+const result2 = await rep.find({
+  where: {           // фильтрация выборки по условию, где указанные
+    type: 'article', // поля документа должны содержать определенные
+    published: true, // значения
+  },
+  order: 'id DESC',  // сортировка по полю "id" в обратном порядке
+  limit: 10,         // ограничение выборки числом документов
+  skip: 5,           // пропуск указанного числа документов
+  fields: [
+    'type',          // включить только указанные поля в результат
+    'title',         // выборки, а остальные поля будут исключены
+  ],
+  include: [         // включить в результат связанные документы
+    'author',        // по имени связи, которые были описаны
+  ],                 // в модели репозитория
+});
 ```
 
 #### findOne(filter = undefined)