Browse Source

chore: updates README.md

e22m4u 3 months ago
parent
commit
b80b2ecc80
1 changed files with 14 additions and 3 deletions
  1. 14 3
      README.md

+ 14 - 3
README.md

@@ -1202,6 +1202,9 @@ dbs.defineModel({
 - `model: string` название целевой модели (обязательно для некоторых типов);
 - `foreignKey: string` свойство текущей модели для идентификатора цели;
 
+*i. Для типов Belongs To и References Many значение параметра `foreignKey`
+можно опустить, так как генерируется автоматически по названию связи.*
+
 **Полиморфный режим**
 
 - `polymorphic: boolean|string` объявление полиморфной связи;
@@ -1210,12 +1213,20 @@ dbs.defineModel({
 *i. Полиморфный режим позволяет динамически определять целевую модель
 по ее названию, которое хранит документ в свойстве-дискриминаторе.*
 
-**Тип связи**
+**Типы связи**
 
-- `belongsTo` - текущая модель содержит свойство для идентификатора цели;
+- `belongsTo` - текущая модель ссылается на целевую по идентификатору;
 - `hasOne` - обратная сторона `belongsTo` по принципу "один к одному";
 - `hasMany` - обратная сторона `belongsTo` по принципу "один ко многим";
-- `referencesMany` - документ содержит массив с идентификаторами целевой модели;
+- `referencesMany` - модель ссылается через массив идентификаторов;
+
+Параметр `type` в определении связи принимает строку с названием типа. Чтобы исключить опечатку, рекомендуется использовать константы объекта `RelationType`
+указанные ниже.
+
+- `RelationType.BELONGS_TO`
+- `RelationType.HAS_ONE`
+- `RelationType.HAS_MANY`
+- `RelationType.REFERENCES_MANY`
 
 **Примеры**