# @scapers/rs-api

> [![Travis](https://img.shields.io/travis/scapers/rs-api.svg)](https://travis-ci.org/scapers/rs-api) [![Coveralls](https://img.shields.io/coveralls/scapers/rs-api.svg)](https://coveralls.io/github/scapers/rs-api) [![Dev Dependencies](https://david-dm.org/s

Latest version **1.2.0** (published 2018-09-04) · MIT license · 0 weekly downloads

## Install

```sh
npm install @scapers/rs-api
pnpm add @scapers/rs-api
yarn add @scapers/rs-api
bun add @scapers/rs-api
```

## Health

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

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

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.0 |
| Published | 2018-09-04 |
| First published | 2018-07-31 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=6.0.0 |
| Dependencies | 0 |
| Unpacked size | 677.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | axke |
| Maintainers | axke |

## Links

- npm: https://www.npmjs.com/package/@scapers/rs-api
- Repository: https://github.com/scapers/rs-api
- Homepage: https://github.com/scapers/rs-api#readme
- Issues: https://github.com/scapers/rs-api/issues
- npm.io page: https://npm.io/package/@scapers/rs-api

## Recent versions

- 1.2.0 (latest) — 2018-09-04
- 1.1.0 — 2018-08-22
- 0.0.0-development — 2018-07-31

## README

# RS-API

[![Travis](https://img.shields.io/travis/scapers/rs-api.svg)](https://travis-ci.org/scapers/rs-api)
[![Coveralls](https://img.shields.io/coveralls/scapers/rs-api.svg)](https://coveralls.io/github/scapers/rs-api)
[![Dev Dependencies](https://david-dm.org/scapers/rs-api/dev-status.svg)](https://david-dm.org/scapers/rs-api?type=dev)

### Introduction
`@scapers/rs-api` is an open source wrapper, written with TypeScript using the [TypeScript library starter](https://github.com/alexjoverm/typescript-library-starter), for the popular MMORPG RuneScape.

NOTE: This package is a TypeScript rewrite of [rs-api](https://github.com/axke/rs-api)

### Installation
`npm install @scapers/rs-api`

### Usage
Documentation can be found at [here](https://scapers.github.io/rs-api)

### Contribution
All `.ts` files are found in the `src` folder. The project is hooked in to scripts via the `package.json` scripts, such as `build`, `test`, `commit`, ect. See NPM scripts section below for more details.

This project is set up using `git-cz`. As such, upon committing, use `npm run commit` and fill the template out.

### NPM scripts

 - `npm t`: Run test suite
 - `npm start`: Run `npm run build` in watch mode
 - `npm run test:watch`: Run test suite in [interactive watch mode](http://facebook.github.io/jest/docs/cli.html#watch)
 - `npm run test:prod`: Run linting and generate coverage
 - `npm run build`: Generate bundles and typings, create docs
 - `npm run lint`: Lints code
 - `npm run commit`: Commit using conventional commit style ([husky](https://github.com/typicode/husky) will tell you to use it if you haven't :wink:)

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