Browse Source

chore: updates README.md

e22m4u 2 years ago
parent
commit
077c169512
1 changed files with 21 additions and 16 deletions
  1. 21 16
      README.md

+ 21 - 16
README.md

@@ -368,23 +368,28 @@ console.log(result);
 Фильтрация результата в параметре `filter`
 
 ```js
-// первый аргумент может принимать объект
-// описывающий параметры выборки
+// первый аргумент опционально принимает
+// объект описывающий параметры выборки
 const result = await rep.find({
-  where: {           // фильтрация выборки по условию, где указанные
-    type: 'article', // поля документа должны содержать определенные
-    published: true, // значения
-  },
-  order: 'id DESC',  // сортировка по полю "id" в обратном порядке
-  limit: 10,         // ограничение выборки числом документов
-  skip: 5,           // пропуск указанного числа документов
-  fields: [
-    'type',          // включить только указанные поля в результат
-    'title',         // выборки, а остальные поля будут исключены
-  ],
-  include: [         // включить в результат связанные документы
-    'author',        // по имени связи, которые были описаны
-  ],                 // в модели репозитория
+  // "where" - фильтрация выборки по условию, где
+  // указанные поля документа должны содержать
+  // определенные значения
+  where: {type: 'article', published: true},
+  // "order" - сортировка по указанному полю может
+  // принимать постфикс ASC или DESC указывающий
+  // направление порядка (прим. 'id DESC')
+  order: 'id',
+  // "limit" - ограничение выборки числом документов
+  limit: 10,
+  // "skip" - пропуск указанного числа документов
+  skip: 5,
+  // "fields" - если определено, то документы выборки
+  // будут включать только указанные поля
+  fields: ['type', 'title'],
+  // "include" - включить в результат связанные
+  // документы по имени связи, которая определена
+  // в модели данной коллекции
+  include: ['author', 'categories'],
 });
 ```