erlc.ts — PRC API Client

A minimal, type-safe TypeScript client for the Police Roleplay Community (PRC) API. No dependencies. No bullshit.

---

Installation

npm install erlc.ts

---

Quick Start

import { PRCClient } from 'erlc.ts';

const client = new PRCClient({ serverKey: 'your-server-key' });

const { data: status } = await client.getServerStatus();
console.log(status);

await client.executeCommand(':h Check out Melonly!');

---

Table of Contents

• Features

• Usage

  • Basic Example
  • Error Handling
  • Cache Control
  • Rate Limit Handling
  • Advanced Usage & Type Safety

• API Reference

  • PRCClient
  • PRCHelpers

• License

---

Features

• 100% TypeScript support
• Built-in caching (in-memory or Redis)
• Automatic rate limit handling
• Fully typed API responses
• 100% API coverage
• Extremely low memory footprint
• Minimal, predictable API

---

Usage

Basic Example

import { PRCClient } from 'erlc.ts';

const client = new PRCClient({ serverKey: 'your-server-key' });

const { data: players } = await client.getPlayers();
players.forEach(p => console.log(p.Player, p.Team));

---

Error Handling

All API calls may throw a PRCAPIError. You can inspect the error type for more detail:

import { PRCClient, PRCAPIError } from 'erlc.ts';

try {
  const { data } = await client.getPlayers();
} catch (err) {
  if (err instanceof PRCAPIError) {
    if (err.isRateLimit) console.error('Rate limited!');
    else if (err.isAuthError) console.error('Bad server key!');
    else console.error('API error:', err.message);
  }
}

---

Cache Control

The client caches GET requests by default. Supports both in-memory and Redis caching.

• Default: 30s
• Disable: cache: false
• Custom: cacheMaxAge (ms)
• Per-method: cacheMaxAge in method options
• Per-method cache control: cache: true/false in method options
• Redis: redisUrl (e.g., redis://localhost:6379)
• Clear manually: client.clearCache()
• Inspect: client.getCacheSize()

// Global cache settings
const client = new PRCClient({
  serverKey: 'your-server-key',
  cacheMaxAge: 120_000, // 2 mins
});

// Per-method cache control
const { data: status } = await client.getServerStatus({ cacheMaxAge: 60_000 }); // 1 min
const { data: players } = await client.getPlayers({ cacheMaxAge: 30_000 }); // 30s

// Enable caching for logs (normally not cached)
const { data: logs } = await client.getJoinLogs({ 
  cache: true, 
  cacheMaxAge: 300_000 
}); // 5 minutes

// Disable caching for a specific call
const { data: freshPlayers } = await client.getPlayers({ cache: false });

---

Rate Limit Handling

---

Rate Limit Handling

Handled automatically:

• Detects retry_after from the API
• Retries up to 3 times
• Throws PRCAPIError with isRateLimit = true if still exceeded

try {
  await client.getPlayers();
} catch (err) {
  if (err instanceof PRCAPIError && err.isRateLimit) {
    console.error('Slow down!');
  }
}

---

Advanced Usage & Type Safety

import { PRCHelpers, Player } from 'erlc.ts';

const helpers = new PRCHelpers(client);

const cops: Player[] = await helpers.getPlayersByTeam('Police');
for (const cop of cops) {
  await helpers.sendPM(cop.Player, 'get ur ass to hq rookie');
}

const stats = await helpers.getServerStats(12);
console.log(`Current players: ${stats.current.players}/${stats.current.maxPlayers}`);

Method Options

All GET methods accept an optional options parameter for per-method configuration:

// Custom cache age for this specific call
const { data: players } = await client.getPlayers({ cacheMaxAge: 60_000 }); // 1 minute

// Enable caching for logs (normally not cached)
const { data: logs } = await client.getJoinLogs({ 
  cache: true, 
  cacheMaxAge: 300_000 
}); // 5 minutes

// Disable caching for a specific call
const { data: freshPlayers } = await client.getPlayers({ cache: false });

---

API Reference

PRCClient Methods

Method	Description	Returns
getServerStatus(options?)	Get current server status	Promise<APIResponse<ServerStatus>>
getPlayers(options?)	Get all players	Promise<APIResponse<Player[]>>
getQueue(options?)	Get server queue	Promise<APIResponse<number[]>>
getVehicles(options?)	Get all vehicles	Promise<APIResponse<Vehicle[]>>
getBans(options?)	Get all bans	Promise<APIResponse<ServerBans>>
getStaff(options?)	Get staff info	Promise<APIResponse<ServerStaff>>
getJoinLogs(options?)	Get join/leave logs	Promise<APIResponse<JoinLog[]>>
getKillLogs(options?)	Get kill logs	Promise<APIResponse<KillLog[]>>
getCommandLogs(options?)	Get command logs	Promise<APIResponse<CommandLog[]>>
getModCalls(options?)	Get mod calls	Promise<APIResponse<ModCall[]>>
executeCommand(cmd)	Run a server command	Promise<APIResponse<null>>
clearCache()	Clear cache	void
getCacheSize()	Cache size	number

---

PRCHelpers Methods

Method	Description
findPlayer(nameOrId) → Player | null	Find player by name or ID
getPlayersByTeam(team) → Player[]	Players on a team
getStaff() → Player[]	All staff players
getOnlineCount() → number	Current online count
isServerFull() → boolean	Is server full?
sendMessage(msg) → void	Send global message
sendPM(player, msg) → void	Send private message
kickPlayer(player, reason?) → void	Kick a player
banPlayer(player, reason?) → void	Ban a player
teleportPlayer(player, target) → void	Teleport player
setTeam(player, team) → void	Set team
getRecentJoins(mins?) → JoinLog[]	Recent joins
getRecentLeaves(mins?) → JoinLog[]	Recent leaves
getPlayerKills(player, hrs?) → KillLog[]	Player kills
getPlayerDeaths(player, hrs?) → KillLog[]	Player deaths
getPlayerCommands(player, hrs?) → CommandLog[]	Player commands
getUnansweredModCalls(hrs?) → ModCall[]	Unanswered mod calls
waitForPlayer(nameOrId, timeout?) → Player	Wait for player
waitForPlayerCount(count, timeout?) → void	Wait for count
kickAllFromTeam(team, reason?) → string[]	Kick all team players
messageAllStaff(msg) → void	Message all staff
getServerStats(hrs?) → { current, recent }	Server stats summary

---

License

MIT