# karaoke-mugen-app-api

> A typed javascript library for accessing a karaokemugen app instance

Latest version **0.5.3** (published 2022-04-02) · ISC license · 0 weekly downloads

## Install

```sh
npm install karaoke-mugen-app-api
pnpm add karaoke-mugen-app-api
yarn add karaoke-mugen-app-api
bun add karaoke-mugen-app-api
```

## Health

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

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

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.5.3 |
| Published | 2022-04-02 |
| First published | 2021-06-27 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 6 |
| Unpacked size | 31.7 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | TheMio |
| Maintainers | themio |
| Keywords | karaoke, kmapp, karaokemugen, api, library |

## Links

- npm: https://www.npmjs.com/package/karaoke-mugen-app-api
- Repository: https://gitlab.com/TheMio/karaoke-mugen-app-api-javascript
- Homepage: https://gitlab.com/TheMio/karaoke-mugen-app-api-javascript#readme
- Issues: https://gitlab.com/TheMio/karaoke-mugen-app-api-javascript/issues
- npm.io page: https://npm.io/package/karaoke-mugen-app-api

## Dependencies (6)

- [request](https://npm.io/package/request.md) ^2.88.2
- [@types/jest](https://npm.io/package/@types/jest.md) ^26.0.23
- [@types/request](https://npm.io/package/@types/request.md) ^2.48.5
- [request-promise](https://npm.io/package/request-promise.md) ^4.2.6
- [request-promise-core](https://npm.io/package/request-promise-core.md) ^1.1.4
- [@types/request-promise](https://npm.io/package/@types/request-promise.md) ^4.1.47

## Recent versions

- 0.5.3 (latest) — 2022-04-02
- 0.5.2 — 2022-04-02
- 0.5.1 — 2022-03-29
- 0.5.0 — 2022-03-29
- 0.3.3 — 2021-11-28
- 0.3.2 — 2021-11-28
- 0.3.1 — 2021-11-28
- 0.3.0 — 2021-11-28
- 0.2.4 — 2021-06-27
- 0.2.3 — 2021-06-27
- 0.2.2 — 2021-06-27
- 0.2.1 — 2021-06-27
- 0.2.0 — 2021-06-27
- 0.1.0 — 2021-06-27

## README

# KaraokeMugen App JavaScript library
A typed javascript library for accessing a karaokemugen app instance.

Currently I only implemented the functions I need myself over the SocketIO REST API, so some features that work over websocket might not be available at this time. If you need more api functions to be added, feel free to implement and commit them. 

# Installation
`npm install --save karaoke-mugen-app-api` or `yarn add karaoke-mugen-app-api`

Then create an instance of the api service 
```
const mugenApi = new MugenApiRest(url, username, password);
```

# Examples
```
const mugenApi = new MugenApiRest(url, username, password);

// Get specific karas and list all titles
const karas = mugenApi.getKaras({ filter: "renai circulation" });
console.log("Found karas: " + karas.content.map(kara => kara.title).join(", "))

```

# Tests
To run the tests you need an active KaraokeMugen-app running and a testuser.
Run tests with `yarn test` or in watchmode `yarn test --watch`

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