# sibfu-timetable-api

> Provides types and util functions for working with sibfu timetable api

Latest version **1.1.2** (published 2021-12-06) · MIT license · 0 weekly downloads

## Install

```sh
npm install sibfu-timetable-api
pnpm add sibfu-timetable-api
yarn add sibfu-timetable-api
bun add sibfu-timetable-api
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.2 |
| Published | 2021-12-06 |
| First published | 2021-12-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 38.4 KB |
| Known vulnerabilities | 0 (+23 in 1 direct dependencies) |
| Install scripts | no |
| Author | Timofey Maximov |
| Maintainers | moltenship |
| Keywords | sibfu, api |

## Links

- npm: https://www.npmjs.com/package/sibfu-timetable-api
- Repository: https://github.com/Moltenship/sibfu-timetable-api
- Homepage: https://github.com/Moltenship/sibfu-timetable-api#readme
- Issues: https://github.com/Moltenship/sibfu-timetable-api/issues
- npm.io page: https://npm.io/package/sibfu-timetable-api

## Dependencies (2)

- [axios](https://npm.io/package/axios.md) ^0.24.0
- [luxon](https://npm.io/package/luxon.md) ^2.1.1

## Recent versions

- 1.1.2 (latest) — 2021-12-06
- 1.1.1 — 2021-12-04
- 1.1.0 — 2021-12-04
- 1.0.3 — 2021-12-03
- 1.0.3-beta.1 — 2021-12-03
- 1.0.2 — 2021-12-03
- 1.0.1 — 2021-12-03
- 1.0.0 — 2021-12-03

## README

# sibfu-timetable-api

[![npm version](https://badgen.net/npm/v/sibfu-timetable-api)](https://npm.im/sibfu-timetable-api)
![size](https://badgen.net/packagephobia/publish/sibfu-timetable-api)
![types](https://badgen.net/npm/types/sibfu-timetable-api)
![tree shaking](https://badgen.net/bundlephobia/tree-shaking/sibfu-timetable-api)

## Features

- ⚡ Blazing fast
- 🔥 Full Typescript support
- 📘 Completely documented
- ⛰️ Built using `Domain-Driven-Development`

## Install

```bash
npm i sibfu-timetable-api
```

## Usage

```ts
import { fetchTimetable } from 'sibfu-timetable-api';

const timetable = await fetchTimetable('your-group-here');

console.log(timetable);
```
And that's it! 🤯

This library also provides helper class `TimetableDate` to interact with dates which is very helpful building timetable application.

```ts
import { TimetableDate } from 'sibfu-timetable-api';

const today = new Date();

const weekType = TimetableDate.getWeekStatus(today);

console.log(weekType); // 1 or 2 depending on your current date which is enum `Week`
```

## Autocomplete module
```ts
import { fetchTargets } from 'sibfu-timetable-api';

const targets = await fetchTimetable('r');

console.log(targets); // ['result-group', 'result-teacher']
```
Always returns the best result for given string! 😱

## Huge thanks 👋
To my friend [choi-moeta](https://github.com/choi-moeta) for inspiring me and helping with creating and publishing this library. 💗

Also huge thanks to [EGOIST](https://github.com/egoist) for creating `tsup` and making it easy to publish library.

## License

MIT © [Moltenship](https://github.com/Moltenship)

---
_Source: https://npm.io/package/sibfu-timetable-api · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._