# comcigan.ts

[star0202](https://github.com/star0202)님의 [comcigan.ts](https://github.com/star0202/comcigan.ts)를 기반으로 합니다.

[![npm version](https://img.shields.io/npm/v/@imnyang/comcigan.ts?style=flat-square)](https://www.npmjs.com/package/@imnyang/comcigan.ts)
![License](https://img.shields.io/github/license/star0202/comcigan.ts?style=flat-square)

[컴시간알리미](http://컴시간학생.kr)를 파싱하는 TypeScript 라이브러리입니다.

컴시간알리미의 구조 및 파싱 방법은 [docs/README.md](./docs/README.md)를 참고해주세요.

## 설치

```bash
npm install @imnyang/comcigan.ts  # npm
yarn add @imnyang/comcigan.ts  # yarn
pnpm add @imnyang/comcigan.ts  # pnpm
bun add @imnyang/comcigan.ts
```

## Forgejo 레지스트리에서 설치하기

이 패키지를 Forgejo 레지스트리에서 설치할 때는 설치하는 프로젝트(consumer) 쪽 설정이 필요합니다.

프로젝트 루트의 `.npmrc`에 아래를 추가하세요.

```ini
@imnyang:registry=https://git.mizuki.guru/api/packages/imnyang/npm/
```

패키지가 비공식(private)인 경우에는 인증 토큰도 필요합니다.

## 사용 예시

```typescript
import Comcigan, { School, Weekday } from 'comcigan.ts'

const comcigan = new Comcigan()

const main = async () => {
  const searchedSchools = await comcigan.searchSchools('학교 이름') // 학교 검색
  const school = await School.fromName('학교 이름') // 바로 불러오기 (== searchedSchools[0])

  console.log(await school.getTimetable(3, 3, Weekday.Friday)) // 3학년 3반 금요일 시간표
  console.log(await comcigan.getTimetable(school.code, 3, 3, Weekday.Friday)) // 학교 코드를 이용하는 방법
}

main()
```