@anzuev/studcloud.rds

RDS module for StudCloud Project

Usage no npm install needed!

<script type="module">
  import anzuevStudcloudRds from 'https://cdn.skypack.dev/@anzuev/studcloud.rds';
</script>

README

Документация

RDS~RDS

Kind: inner class of RDS

RDS.configure()

Настройка модуля

Kind: static method of RDS
Throws:

  • Error , не смог подключиться к базе данных.

this: {RDS}

RDS.getUniversityModel() ⇒ Mongoose.model

Получение класса University для работы с типами работ

Kind: static method of RDS
Throws:

  • DbError , 500 - модуль не был инициализирован

RDS.getWorkTypeModel() ⇒ Mongoose.model

Получение класса WorkType для работы с типами работ

Kind: static method of RDS
Throws:

  • DbError , 500 - модуль не был инициализирован

RDS.getSubjectModel() ⇒ Mongoose.model

Получение класса Subject для работы с типами работ

Kind: static method of RDS
Throws:

  • DbError , 500 - модуль не был инициализирован

RDS~Subject

Kind: inner class of RDS
Properties

Name Type Description
title string название
created date дата создания
updated date дата обновления
enabled boolean Активен ли предмет?

subject.saveSubject() ⇒ Subject

Безопасное сохранение предмета

Kind: instance method of Subject
Throws:

  • DbError , 500 - ошибка базы данных

this: {Subject}

subject.getTitle() ⇒ string

Получение имени предмета

Kind: instance method of Subject
this: {Subject}

Subject.isExist(id) ⇒ promise

Проверка существуюет ли такой предмет

Kind: static method of Subject
this: {Subject}
Fulfill: boolean, true - предмет существует, false - предмета нет.
Reject: DbError, 500 - ошибка бд

Param Description
id идентификатор предмета

Subject.getById(id) ⇒ Promise

Получение предмета по id

Kind: static method of Subject
this: {Subject}
Fulfill: Subject - все прошло хорошо
Reject: DbError, 404 - не найден предмет по id
Reject: DbError, 500 - ошибка базы данных.

Param Description
id идентификатор предмета

Subject.getEnabled(query, skip) ⇒ promise

Поиск/получение неактивированных предметов

Kind: static method of Subject
this: {Subject}
Fulfill: Subject
Reject: DbError, 204 - ничего не найдено
Reject: DbError, 500 - ошибка сервера бд

Param Type Description
query опционально. Строка для поиска
skip number сколько страниц пропускаем сначала?

Subject.getAll(query, skip) ⇒ promise

Поиск/получение по всем предметам

Kind: static method of Subject
this: {Subject}
Fulfill: Subject
Reject: DbError, 204 - ничего не найдено
Reject: DbError, 500 - ошибка сервера бд

Param Type Description
query опционально. Строка для поиска
skip number сколько страниц пропускаем сначала?

Subject.getDisabled(query, skip) ⇒ promise

Поиск/получение неактивированных предметов

Kind: static method of Subject
this: {Subject}
Fulfill: Subject
Reject: DbError, 204 - ничего не найдено
Reject: DbError, 500 - ошибка сервера бд

Param Type Description
query опционально. Строка для поиска
skip number сколько страниц пропускаем сначала?

Subject.setName(id, newTitle) ⇒ promise

Изменение title у предмета,

Kind: static method of Subject
this: {Subject}
Reject: DbError, 400 - нарушена уникальность названия
Reject: DbError, 500 - ошибка бд
Fulfill: Subject объект типа Subject

Param Description
id идентификатор
newTitle новое название

Subject.enable(id) ⇒ promise

Активация предмета по id,

Kind: static method of Subject
this: {Subject}
Fulfill: WorkType - все прошло хорошо
Reject: DbError, 404 - не найден тип по id
Reject: DbError, 500 - ошибка базы данных.

Param Description
id идентификатор работы

Subject.disable(id) ⇒ promise

Дизактивация работы по id

Kind: static method of Subject
this: {Subject}
Fulfill: WorkType - все прошло хорошо
Reject: DbError, 404 - не найден тип по id
Reject: DbError, 500 - ошибка базы данных.

Param Description
id идентификатор работы

RDS~Faculty

Kind: inner class of RDS
Properties

Name Type Description
title string полное название
shortTitle string сокращенное название
created date дата создания
updated date дата обновления
id mongoose.Types.ObjectId идентификатор

faculty.getShortTitle() ⇒ string

Kind: instance method of Faculty
Summary: Получение краткого названия университета
Returns: string - - краткое название
this: {Faculty}

faculty.formatForSearch(format) ⇒ object

Kind: instance method of Faculty
Summary: Метод для форматирования факультетов или университетов для выдачи
Returns: object - formatted faculty
this: {Faculty}

Param Type Description
format boolean true - длинное(title), false - краткое(shortTitle)

Faculty.getTitle() ⇒ string

Kind: static method of Faculty
Summary: Получение названия университета
Returns: string - - название
this: {Faculty}

RDS~University

Kind: inner class of RDS
Properties

Name Type Description
title String полное название
shortTitle String сокращенное название
faculties Array.<Faculty> массив факультетов
location.city String Город
location.street String улица
location.building string Номер дома
rating number рейтинг университета
created date дата создания
updated date дата обновления
enabled boolean Активен ли предмет?
_id mongoose.Types.ObjectId идентификатор

university.getTitle() ⇒ string

Kind: instance method of University
Summary: Получение названия университета
Returns: string - - название
this: {University}

university.getShortTitle() ⇒ String

Kind: instance method of University
Summary: Получение краткого названия университета
Returns: String - - краткое название
this: {University}

university.formatForSearch(format) ⇒ object

Kind: instance method of University
Summary: Метод для форматирования факультетов или университетов для выдачи
Returns: object - formatted University
this: {University}

Param Type Description
format boolean true - длинное(title), false - краткое(shortTitle)

university.saveUniversity() ⇒ university

Kind: instance method of University
Summary: Безопасное сохранение университета
Throws:

  • DbError , 500 - ошибка базы данных

this: {University}

University.getById(id) ⇒ Promise

Kind: static method of University
Summary: Получение университета по id
this: {University}
Fulfill: University - все прошло хорошо
Reject: DbError, 404 - не найден тип по id
Reject: DbError, 500 - ошибка базы данных.

Param Description
id идентификатор типа

University.getFaculties(university, format,) ⇒ Promise

Kind: static method of University
Summary: Метод для получения списка факультетов в рамках одного универа по id
this: {University}
Fulfill: - Массив для выдачи
Reject{dberror},: 204 - не найдено факультетов
Reject: DbError, 500 - ошибка базы данных.

Param Type Description
university string id университета
format, boolean true - длинное(title), false - краткое(shortTitle)

University.getUniversities(format) ⇒ promise

Kind: static method of University
Summary: Метод для получения списка универов
this: {University}
Fulfill: - Массив для выдачи
Reject: DbError, 204 - не найдено университетов
Reject: DbError, 500 - ошибка базы данных.

Param Type Description
format boolean true - длинное(title), false - краткое(shortTitle)

University.getUniversitiesByTitle(title, format) ⇒ Promise

Kind: static method of University
Summary: Получение университетов по названию
this: {University}
Fulfill: - Массив для выдачи
Reject: DbError, 204 - не найдено университетов
Reject: DbError, 500 - ошибка базы данных.

Param Type Description
title строка поиска
format boolean true - длинное(title), false - краткое(shortTitle)

University.getFacultiesByTitle(title, university, format) ⇒ Promise

Kind: static method of University
Summary: Получение университетов по названию
this: {University}
Fulfill: - Массив для выдачи
Reject: DbError, 204 - не найдено университетов
Reject: DbError, 500 - ошибка базы данных.

Param Type Description
title строка для поиска
university идентификатор университета
format boolean true - длинное(title), false - краткое(shortTitle)

University.isExist(university, faculty) ⇒ promise

Kind: static method of University
Summary: Метод проверки валидности университета и факультета
this: {University}
Fulfill: boolean, true - данные валидны, false - данные не валидны
Reject: DbError, 500 - ошибка базы данных

Param Description
university идентификатор университета
faculty идентификатор факульета

University.getUniversityAndFacultyTitles(university, faculty) ⇒ Promise

Kind: static method of University
Summary: Метод, возвращающий названия факультета и университета
this: {University}
Fulfill: object, проперти university, faculty
Reject: DbError, 500 - ошибка базы данных

Param Description
university идентификатор университета
faculty идентификатор факульета

University.createNew(title, shortTitle, street, building, city, rating) ⇒ promise

Kind: static method of University
Summary: Добавление нового университета
this: {University}

Param Description
title полное название
shortTitle краткое название
street улица/проспект
building номер дома
city город
rating рейтинг

University.addFaculty(title, shortTitle)

Kind: static method of University
Summary: Добавление нового факультета в университет
Throws:

  • ValidationError , 400 - Факультет уже присутствует в университете

this: {University}

Param Description
title полное название
shortTitle краткое название

RDS~WorkType

Kind: inner class of RDS
Properties

Name Type Description
title string название
created date дата создания
updated date дата обновления
enabled boolean Активен ли предмет?
tags Array.<string> Тэги

workType.saveType() ⇒ WorkType

Безопасное сохранение типа

Kind: instance method of WorkType
Throws:

  • DbError , 500 - ошибка базы данных

this: {WorkType}

WorkType.setName(id, newTitle) ⇒ Promise

Изменение title у типа работы

Kind: static method of WorkType
this: {WorkType}
Fulfil: WorkType, объект типа WorkType
Reject: DbError, 400 - нарушена уникальность названия
Reject: DbError, 404 - нет типа с таким названием
Reject: DbError, 500 - ошибка бд

Param Description
id идентификатор типа работы
newTitle новое название

WorkType.enable(id) ⇒ Promise

Активация работы по id

Kind: static method of WorkType
this: {WorkType}
Fulfill: WorkType - все прошло хорошо
Reject: DbError, 404 - не найден тип по id
Reject: DbError, 500 - ошибка базы данных.

Param Description
id идентификатор работы

WorkType.disable(id) ⇒ Promise

Дизактивация работы по id

Kind: static method of WorkType
this: {WorkType}
Fulfill: WorkType - все прошло хорошо
Reject: DbError, 404 - не найден тип по id
Reject: DbError, 500 - ошибка базы данных.

Param Description
id идентификатор работы

WorkType.getById(id) ⇒ Promise

Получение типа по id

Kind: static method of WorkType
this: {WorkType}
Fulfill: WorkType - все прошло хорошо
Reject: DbError, 404 - не найден тип по id
Reject: DbError, 500 - ошибка базы данных.

Param Description
id идентификатор типа

WorkType.getEnabled(query, skip) ⇒ Promise

Поиск/получение неактивированных типов

Kind: static method of WorkType
this: {WorkType}
Fulfill: workType
Reject: DbError, 204 - ничего не найдено
Reject: DbError, 500 - ошибка сервера бд

Param Type Description
query опционально. Строка для поиска
skip number сколько страниц пропускаем сначала?

WorkType.getAll(query, skip) ⇒ Promise

Поиск/получение по всем типам работ

Kind: static method of WorkType
this: {WorkType}
Fulfill: workType
Reject: DbError, 204 - ничего не найдено
Reject: DbError, 500 - ошибка сервера бд

Param Type Description
query опционально. Строка для поиска
skip number сколько страниц пропускаем сначала?

WorkType.getDisabled(query, skip) ⇒ Promise

Поиск/получение неактивированных типов

Kind: static method of WorkType
this: {WorkType}
Fulfill: workType
Reject: DbError, 204 - ничего не найдено
Reject: DbError, 500 - ошибка сервера бд

Param Type Description
query опционально. Строка для поиска
skip number сколько страниц пропускаем сначала?

WorkType.isExist(id) ⇒ Promise

Проверка существуюет ли такой тип

Kind: static method of WorkType
this: {WorkType}
Fulfill: boolean, true - тип существует, false - типа нет.
Reject: DbError, 500 - ошибка бд

Param Description
id идентификатор типа