#Classes
| Class | Description |
|---|---|
| Represents a player banned from an ER:LC server. | |
| Manager responsible for fetching and caching the server's ban list. | |
| Represents the base class for all ER:LC structures. | |
| The main client for interacting with the ER:LC API and gateway. Manages multiple ER:LC game servers, each with its own caches and polling loop. | |
| A collection class that extends the built-in Map class, providing additional utility methods for managing key-value pairs. K - The type of keys in the collection. V - The type of values in the collection. | |
| Represents a logged command execution event. | |
| Manager responsible for fetching, caching, and updating CommandLog structures. | |
| Manager responsible for executing custom console commands in the ER:LC server. | |
| Error thrown when a custom in-game command is invalid. | |
| Error thrown when two configured server keys resolve to the same server ID. | |
| Represents an active emergency call in the ER:LC server. | |
| Manager responsible for fetching, caching, and updating active EmergencyCall structures. | |
| Error thrown when the ER:LC API returns an error. | |
| Error thrown if the in-game command is invalid. | |
| Error thrown when an invalid ER:LC Global API Key is provided. | |
| Error thrown when an invalid ER:LC Server API Key is provided. | |
| Represents a server join or leave log entry. | |
| Manager responsible for fetching, caching, and updating JoinLog structures. | |
| Represents a log of a player death event (kill). | |
| Manager responsible for fetching, caching, and updating KillLog structures. | |
| Error thrown when an authorization link is requested without a global app ID. | |
| Represents a request for moderation help (moderator call) in the ER:LC server. | |
| Manager responsible for fetching, caching, and updating ModCall structures. | |
| Error thrown when unauthenticated requests are made for multiple servers. | |
| Error thrown when a command is sent to a private server that has no players. | |
| Error thrown when the server being accessed is out of date. | |
| Represents a player in the ER:LC server. | |
| Manager responsible for fetching, caching, and updating Player structures. | |
| Error thrown when the message sent is prohibited. | |
| Handles communication with the ER:LC HTTP API for all servers managed by a Client, managing rate limits and request queuing on a shared per-IP budget. Buckets are gated conservatively: the server-reported remaining budget is reduced by tracked in-flight requests, and no request is dispatched while that effective budget is exhausted. A bucket's queue is frozen (with jittered backoff) while a | |
| Error thrown when the command is restricted. | |
| Error thrown when the resource being accessed is restricted. | |
| Represents a single ER:LC game server managed by a Client. Holds the server's own managers, caches, polling loop, and webhook routing. | |
| Error thrown if the server key is banned from accessing the ER:LC API. | |
| Represents the current configuration/state snapshot of an ER:LC game server. | |
| Collection of the ER:LC game servers managed by a Client, keyed by server ID. | |
| Error thrown when a webhook event targets a server that has no configured API key. | |
| Error thrown when the ER:LC Private Server is offline. | |
| Represents a staff member. | |
| Manager responsible for fetching, caching, and updating Staff structures. | |
| Error thrown when a timeout occurs. | |
| Error thrown if the request was unauthorized. This is normally thrown when the IP was not whitelisted or the global app was not authorized for that server. To authorize an IP go to https://api.erlc.gg/server-owners. To create a global app for an authorization link go to https://api.erlc.gg/developers/applications. To create an authorization link for your global app do | |
| Represents a spawned vehicle in the ER:LC server. | |
| Manager responsible for fetching, caching, and updating Vehicle structures. | |
| Webhook Server for handling real-time gateway events pushed by ER:LC for all managed servers. Incoming events are routed to the matching server by the top-level |
#Enumerations
| Enumeration | Description |
|---|---|
| Event names emitted by the erlcjs Client. | |
| The permission levels a player can hold in an ER:LC server. | |
| Enumeration of vehicle names available in ER:LC. |
#Functions
| Function | Description |
|---|---|
#Interfaces
| Interface | Description |
|---|---|
| Interface mapping client event names to their callback parameters. | |
| Configuration options for the ERLCApi Client. | |
| Response returned by the ER:LC command endpoint. | |
| In-Game command structure. | |
| Raw data structure representing a executed command log entry. | |
| Raw data structure representing an emergency call. | |
| Raw data structure representing a server join/leave log entry. | |
| Raw data structure representing a kill log entry. | |
| Raw data structure representing a moderator call log. | |
| Raw data structure representing a player from the ERLC API. | |
| Raw data structure representing the full server information payload from ER:LC. | |
| Raw data structure representing server staff records. | |
| Raw data structure representing a vehicle. | |
| Raw data structure representing a webhook emergency call. |
#Type Aliases
| Type Alias | Description |
|---|---|
| Raw ban list returned by | |
| The raw permission values returned by the ER:LC API. |