# erlc

> An ER:LC API wrapper for JS/TS

Latest version **1.2.0** (published 2023-12-22) · MIT license · 0 weekly downloads

## Install

```sh
npm install erlc
pnpm add erlc
yarn add erlc
bun add erlc
```

## 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 | 2023-12-22 |
| First published | 2023-11-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 14.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 8 |
| Author | 0xRaptor |
| Maintainers | 0xraptor |
| Keywords | erlc, roblox, prc, erlc api |

## Links

- npm: https://www.npmjs.com/package/erlc
- Repository: https://github.com/0xRaptor/erlc
- Homepage: https://github.com/0xRaptor/erlc#readme
- Issues: https://github.com/0xRaptor/erlc/issues
- npm.io page: https://npm.io/package/erlc

## Dependencies (1)

- [node-fetch](https://npm.io/package/node-fetch.md) ^3.3.2

## Alternatives

- [jsforce](https://npm.io/package/jsforce.md) — 851.2K weekly downloads
- [react-native-qrcode-svg](https://npm.io/package/react-native-qrcode-svg.md) — 693.5K weekly downloads
- [@salesforce/plugin-data](https://npm.io/package/@salesforce/plugin-data.md) — 394.9K weekly downloads
- [@backstage/plugin-search-common](https://npm.io/package/@backstage/plugin-search-common.md) — 308.5K weekly downloads
- [@chain-registry/types](https://npm.io/package/@chain-registry/types.md) — 38.4K weekly downloads

## Recent versions

- 1.2.0 (latest) — 2023-12-22
- 1.1.2 — 2023-11-30
- 1.1.1 — 2023-11-30
- 1.0.0 — 2023-11-30

## README

# ER:LC API Wrapper
A lightweight API Wrapper with 100% coverage of the ER:LC API.


## Getting Started
First you need to install the package.


`npm i erlc`

### Setting Up
Setting up is super simple:
```js
// index.js
    
const erlc = require('erlc')
const client = new erlc.Client({
	globalToken: '' // Here you enter your global token provided for the API
})
client.config() // Registers your client
```
Now you can start using API Methods - here are a few examples:
```js
// api.js
	
const erlc = require('erlc')
	
const getServerFunc = async () => {
    const serverId="" // The server ID you wish to target
    const server = await erlc.getServer(serverId).catch(console.log) // Gets the server, logs any errors
		
    console.log(server) // Logs the server object
}

getServerFunc()
```   

### [PRC API Docs](https://apidocs.policeroleplay.community/reference/api-reference)

### Credits
Library Development - [0xRaptor](https://twitter.com/0xRaptorRblx)
API Development - [Police Roleplay Community](https://twitter.com/PRC_Roblox)

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