# dgsw-meal

> Daegu Software High School meal Parsing Library for node.js

Latest version **1.2.0** (published 2020-07-14) · MIT license · 0 weekly downloads

## Install

```sh
npm install dgsw-meal
pnpm add dgsw-meal
yarn add dgsw-meal
bun add dgsw-meal
```

## Health

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

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.0 |
| Published | 2020-07-14 |
| First published | 2020-05-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=8.0.0 |
| Dependencies | 2 |
| Unpacked size | 29.1 KB |
| Known vulnerabilities | 0 (+26 in 2 direct dependencies) |
| Install scripts | no |
| GitHub stars | 8 |
| Author | wlsdud2194 |
| Maintainers | devjin2194 |
| Keywords | meal, dgsw, school |

## Links

- npm: https://www.npmjs.com/package/dgsw-meal
- Repository: https://github.com/wlsdud2194/dgsw-meal
- Homepage: https://github.com/wlsdud2194/dgsw-meal.git
- Issues: https://github.com/wlsdud2194/dgsw-meal/issues
- npm.io page: https://npm.io/package/dgsw-meal

## Dependencies (2)

- [axios](https://npm.io/package/axios.md) ^0.19.2
- [@hapi/joi](https://npm.io/package/@hapi/joi.md) ^17.1.1

## Recent versions

- 1.2.0 (latest) — 2020-07-14
- 1.1.1 — 2020-06-03
- 1.1.0 — 2020-05-22
- 1.0.4 — 2020-05-06
- 1.0.3 — 2020-05-06
- 1.0.2 — 2020-05-06
- 1.0.1 — 2020-05-04

## README

# dgsw-meal
Daegu Software High School meal Parsing Library for node.js

![](https://github.com/wlsdud2194/dgsw-meal/workflows/build/badge.svg)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![npm version](https://badge.fury.io/js/dgsw-meal.svg)](https://badge.fury.io/js/dgsw-meal)

## Table of Contents
- Installation
- Usage Example
- Licence 

## Installation
you can install to use npm or yarn
```
npm install dgsw-meal
yarn install dgsw-meal
```

## Usage Example

### `getMeal(year, month)`

| parameter | type   | required | description                       |
|:---------:|:------ | :------- | :-------------------------------- |
| year      | number | true     | the year to search                |
| month     | number | true     | the month to search from 1 to 12  |

- example
```js
const dgswMeal = require('dgsw-meal'); // es5
import * as dgswMeal from 'dgsw-meal'; // es6

dgswMeal.getMeal(2020, 5).then(console.log);
/** console
  {
    "year": number,
    "month": number,
    "currentDay": number,
    "meal": {
      "1": string, // 1st menu
      "2": string,
      ...
      "31": "[조식]...[중식]...[석식]...",
    },
    "today": string,
  }
*/
```

## Licence
[MIT](https://github.com/wlsdud2194/dgsw-meal/blob/master/LICENSE)

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