Class: OpenCloudError

Defined in: src/errors.ts:5

Base error class for all Roblox Open Cloud API errors. Extends the native Error class with additional context about API failures.

Extends

• Error

Extended by

• RateLimitError
• AuthError

Constructors

Constructor

new OpenCloudError(
   message, 
   status?, 
   code?, 
   details?): OpenCloudError;

Defined in: src/errors.ts:14

Creates a new OpenCloudError instance.

Parameters

Parameter	Type	Description
message	string	Human-readable error message
status?	number	HTTP status code (e.g., 404, 500)
code?	string	Error code from the API (e.g., "RESOURCE_NOT_FOUND")
details?	unknown	Additional error details from the API response

Returns

OpenCloudError

Overrides

Error.constructor

Properties

status?

optional status: number;

Defined in: src/errors.ts:16

HTTP status code (e.g., 404, 500)

---

code?

optional code: string;

Defined in: src/errors.ts:17

Error code from the API (e.g., "RESOURCE_NOT_FOUND")

---

details?

optional details: unknown;

Defined in: src/errors.ts:18

Additional error details from the API response