@e22m4u/js-repository 0.8.4 → 0.8.6

package/README.md

@@ -11,11 +11,10 @@
 - [Импорт](#импорт)
 - [Описание](#описание)
 - [Пример](#пример)
-- [Схема](#схема)
+- [Схема баз данных](#схема-баз-данных)
 - [Источник данных](#источник-данных)
 - [Модель](#модель)
 - [Свойства](#свойства)
-- [Пустые значения](#пустые-значения)
 - [Репозиторий](#репозиторий)
   - [create](#repositorycreate)
   - [replaceById](#repositoryreplacebyid)
@@ -94,7 +93,7 @@ const {DatabaseSchema} = require('@e22m4u/js-repository');
 ```mermaid
 flowchart TD
 
-  A[Схема]
+  A[DatabaseSchema]
   subgraph Базы данных
     B[Источник данных 1]
     C[Источник данных 2]
@@ -104,9 +103,9 @@ flowchart TD
 
   subgraph Коллекции
     D[Модель A]
-    E[Модель Б]
-    F[Модель В]
-    G[Модель Г]
+    E[Модель B]
+    F[Модель C]
+    G[Модель D]
   end
   B-->D
   B-->E
@@ -114,9 +113,9 @@ flowchart TD
   C-->G
 
   H[Репозиторий A]
-  I[Репозиторий Б]
-  J[Репозиторий В]
-  K[Репозиторий Г]
+  I[Репозиторий B]
+  J[Репозиторий C]
+  K[Репозиторий D]
   D-->H
   E-->I
   F-->J
@@ -254,9 +253,12 @@ console.log(cityWithCountry);
 // }
 ```
 
-## Схема
+## Схема баз данных
 
-Экземпляр класса `DatabaseSchema` хранит определения источников данных и моделей.
+Экземпляр класса `DatabaseSchema` (далее *«Схема»*) хранит определения
+источников данных и моделей. Схема связывает модели с источниками данных
+и используется для получения репозиториев, которые выполняют операции
+чтения и записи.
 
 **Методы**
 
@@ -384,14 +386,15 @@ dbs.defineModel({
 **Параметры**
 
 - `type: string` тип допустимого значения (обязательно);
-- `itemType: string` тип элемента массива (для `type: 'array'`);
-- `model: string` модель объекта (для `type: 'object'`);
-- `primaryKey: boolean` объявить свойство первичным ключом;
-- `columnName: string` переопределение названия колонки;
-- `columnType: string` тип колонки (определяется адаптером);
-- `required: boolean` объявить свойство обязательным;
-- `default: any` значение по умолчанию;
-- `unique: boolean | string` проверять значение на уникальность;
+- `itemType?: string` тип элемента массива (для `type: 'array'`);
+- `itemModel?: string` модель элемента массива (для `type: 'array'`);
+- `model?: string` модель объекта (для `type: 'object'`);
+- `primaryKey?: boolean` объявить свойство первичным ключом;
+- `columnName?: string` переопределение названия колонки;
+- `columnType?: string` тип колонки (определяется адаптером);
+- `required?: boolean` объявить свойство обязательным;
+- `default?: any` значение по умолчанию (заменяет `undefined` и `null`);
+- `unique?: boolean | string` проверять значение на уникальность;
 
 **Параметр `unique`**
 
@@ -399,15 +402,19 @@ dbs.defineModel({
 строгая проверка на уникальность. В этом режиме любое значение данного свойства
 не может быть представлено более одного раза.
 
-Режим `"sparse"` проверяет только значения с полезной нагрузкой, исключая
-[пустые значения](#пустые-значения), список которых отличается в зависимости
-от типа свойства. Например, для типа `string` пустым значением будет
-`undefined`, `null` и `""` (пустая строка).
-
 - `unique: true | 'strict'` строгая проверка на уникальность;
-- `unique: 'sparse'` исключить из проверки [пустые значения](#пустые-значения);
+- `unique: 'sparse'` исключить из проверки ложные значения;
 - `unique: false | 'nonUnique'` не проверять на уникальность (по умолчанию);
 
+Режим `"sparse"` исключает из проверки на уникальность ложные значения с точки
+зрения JavaScript. Указанные ниже значения будут проигнорированы при проверке
+в данном режиме.
+
+- `""` пустая строка;
+- `0` число ноль;
+- `false` логическое отрицание;
+- `undefined` и `null`;
+
 В качестве значений параметра `unique` можно использовать предопределенные
 константы как эквивалент строковых значений `strict`, `sparse` и `nonUnique`.
 
@@ -471,25 +478,6 @@ dbs.defineModel({
 });
 ```
 
-## Пустые значения
-
-Разные типы свойств имеют свои наборы пустых значений. Эти наборы используются
-для определения наличия полезной нагрузки в значении свойства. Например,
-параметр `default` в определении свойства устанавливает значение по умолчанию,
-только если входящее значение является пустым. Параметр `required` исключает
-пустые значения выбрасывая ошибку. А параметр `unique` в режиме `sparse`
-наоборот допускает дублирование пустых значений уникального свойства,
-поскольку они не участвуют в проверке.
-
-| тип свойства       | пустые значения            |
-|--------------------|----------------------------|
-| `DataType.ANY`     | *значения остальных типов* |
-| `DataType.STRING`  | `undefined`, `null`, `""`  |
-| `DataType.NUMBER`  | `undefined`, `null`        |
-| `DataType.BOOLEAN` | `undefined`, `null`        |
-| `DataType.ARRAY`   | `undefined`, `null`        |
-| `DataType.OBJECT`  | `undefined`, `null`        |
-
 ## Репозиторий
 
 Репозиторий выполняет операции чтения и записи данных определенной модели.
@@ -514,8 +502,8 @@ dbs.defineModel({
 
 - `id: number|string` идентификатор (первичный ключ);
 - `data: object` данные документа (используется при записи);
-- `where: object` условия фильтрации (см. [Фильтрация](#Фильтрация));
-- `filter: object` параметры выборки (см. [Фильтрация](#Фильтрация));
+- `where: object` условия фильтрации (см. [Фильтрация](#фильтрация));
+- `filter: object` параметры выборки (см. [Фильтрация](#фильтрация));
 
 **Получение репозитория**
 
@@ -851,8 +839,8 @@ if (!product) {
 
 ### repository.findById
 
-Находит один документ по его уникальному идентификатору. Если документ не
-найден, выбрасывается ошибка.
+Поиск документа по идентификатору. Если документ не найден, выбрасывается
+ошибка.
 
 Сигнатура:
 
@@ -1378,7 +1366,7 @@ const res = await rep.find({
 
 Параметр включает связанные документы в результат вызываемого метода.
 Названия включаемых связей должны быть определены в текущей модели.
-(см. [Связи](#Связи))
+(см. [Связи](#связи))
 
 **Примеры**