О проекте

[!WARNING] Данная библиотека была создана энтузиастом на основе личных наблюдений по работе с API ЭлЖура.

Данный проект создан для людей.
Мы хотим предоставить удобную и читаемую документацию для заинтересованных лиц. Для этого, как один из этапов, была создана данная библиотека, которая описывает необходимые сущности, для работы с API ЭлЖура.
Если вы являетесь разработчиком на JavaScript или TypeScript (или просто ознакомлены с данными языками) - вы точно также можете спокойно и удобно использовать данную библиотеку.

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

[!NOTE] Данная документация основана на данной библиотеке, а точнее её ветке open-api. Она была отдельно создана, чтобы не захламлять библиотеку лишними зависимостями и кусочками кода.

Для просмотра полной документации посетите https://betterjournal.ru/eljur-api.

Использование

В качестве типизации:

npm install -D @betterjournal/eljur-api

import type { ISuccessAPIResponse, IFailedAPIResponse, ByStudentsObject, IDiaryRecord } from "./";

(async () => {
	const res = await fetch(/*...*/);

	if (res.ok) {
		const user = (await res.json()) as ISuccessAPIResponse<ByStudentsObject<IDiaryRecord>>;
		//...
	} else {
		const failed = (await res.json()) as IFailedAPIResponse;
		//...
	}

	//...
})();

Напрямую:

npm install @betterjournal/eljur-api

import { SuccessAPIResponse, FailedAPIResponse, byStudentsObject, DiaryRecord } from "./";

(async () => {
	const res = await fetch(/*...*/);

	if (res.ok) {
		const user = SuccessAPIResponse(byStudentsObject(DiaryRecord)).parse(await res.json());
		//...
	} else {
		const failed = FailedAPIResponse.parse(await res.json());
		//...
	}

	//...
})();

[!IMPORTANT] Имейте в виду, что типы могут отличаться в зависимости от конкретной системы.

Огромная благодарность каждому, кто установит данную библиотеку.
Желаем каждому успехов!