From 287f273c69d81355c2039540172ffafce7df8009 Mon Sep 17 00:00:00 2001 From: Starcea Date: Fri, 28 Apr 2023 20:32:08 +0900 Subject: [PATCH] docs: example --- README.md | 38 +++++++++++++++++++++++++++++--------- 1 file changed, 29 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 89ffd8b..7c26fed 100644 --- a/README.md +++ b/README.md @@ -24,31 +24,51 @@ pnpm add neis.ts ```ts import { Neis } from 'neis.ts' -import { Logger } from 'tslog' // Optional +import { Logger } from 'tslog' -const logger = new Logger() // Optional +const logger = new Logger() const neis = new Neis({ - // NeisConfig 참고 KEY: 'API KEY', Type: 'json', pIndex: 1, pSize: 100, - logger: logger, // Optional + logger: logger.getSubLogger({ + name: 'neis', + }), }) ;(async () => { - const school = await neis.getSchoolOne({ - // SchoolRequestParams 참고 + // 학교 + const school = await neis.getSchool({ + // or getSchoolOne ATPT_OFCDC_SC_CODE: '시도교육청코드', SD_SCHUL_CODE: '표준학교코드', }) - const meal = await school.getMealOne({ - // MealRequestParams 참고 - MLSV_YMD: 'yyyymmdd', + + // 급식 + const meal = await neis.getMeal({ + ATPT_OFCDC_SC_CODE: '시도교육청코드', + SD_SCHUL_CODE: '표준학교코드', + MLSV_YMD: '날짜', + }) + + // 학사일정 + const schedule = await neis.getSchedule({ + ATPT_OFCDC_SC_CODE: '시도교육청코드', + SD_SCHUL_CODE: '표준학교코드', + AA_YMD: '날짜', + }) + + // 학원 / 교습소 + const academy = await neis.getAcademy({ + ATPT_OFCDC_SC_CODE: '시도교육청코드', + ACA_ASNUM: '학원지정번호', }) console.log(school) console.log(meal) + console.log(schedule) + console.log(academy) })() ```