Browse Source

chore: updates README.md

e22m4u 2 years ago
parent
commit
c208880733
1 changed files with 13 additions and 5 deletions
  1. 13 5
      README.md

+ 13 - 5
README.md

@@ -248,8 +248,8 @@ console.log(person);
 Использование параметра `filter`
 
 ```js
-// второй параметр опционально принимает объект
-// с настройками возвращаемого результата
+// второй параметр принимает объект настроек
+// возвращаемого результата (опционально)
 const result = await rep.create(data, {
   // "fields" - если определено, то возвращаемый
   // документ будут включать только указанные поля
@@ -271,25 +271,33 @@ const result = await rep.create(data, {
 Возвращает затронутый документ.  
 
 ```js
+// перед вызовом метода `replaceById` документ
+// с идентификатором 1 имеет следующую структуру
 // {
 //   id: 1,
 //   name: 'Rick Sanchez',
 //   dimension: 'C-137',
 //   age: 67
 // }
+
+// первым аргументом передаем идентификатор,
+// документа, а вторым данные для замены
 const person = await rep.replaceById(1, {
   name: 'Morty Smith',
   kind: 'a young teenage boy',
   age: 14,
 });
 
+// выводим результирующий документ
 console.log(person);
 // {
 //   id: 1,
-//   name: 'Morty Smith',
-//   kind: 'a young teenage boy',
-//   age: 14
+//   name: 'Morty Smith', <= значение обновлено
+//   kind: 'a young teenage boy', <= новое значение
+//   age: 14 <= значение обновлено
 // }
+// поле "dimension" удалено, так как
+// не содержалось в заменяемых данных
 ```
 
 #### patch(data, where = undefined)