Browse Source

chore: updates README.md

e22m4u 2 years ago
parent
commit
e28599010c
1 changed files with 12 additions and 0 deletions
  1. 12 0
      README.md

+ 12 - 0
README.md

@@ -71,6 +71,11 @@ schema.defineDatasource({
 });
 ```
 
+Параметры источника:
+
+- `name: string` название нового источника
+- `adapter: string` выбранный адаптер базы данных
+
 При желании можно использовать встроенный адаптер `memory`, который хранит
 данные в памяти процесса. У него нет специальных настроек, и он отлично
 подходит для тестов и прототипирования.
@@ -103,6 +108,13 @@ schema.defineModel({
 });
 ```
 
+Параметры модели:
+
+- `name: string` название новой модели (обязательно)
+- `datasource: string` выбранный источник данных
+- `properties: object` определения полей модели
+- `relations: object` определения связей модели
+
 Параметр `properties` принимает объект, ключи которого являются именами
 полей, а значением тип поля или объект с дополнительными параметрами.