Interface: OpenCloudConfig

Defined in: src/index.ts:10

Configuration options for initializing the OpenCloud SDK client.

Properties

apiKey?

optional apiKey: string;

Defined in: src/index.ts:15

Roblox Open Cloud API key for authentication. This is optional and if not provided, you must use withAuth() for per-request authentication.

---

userAgent?

optional userAgent: string;

Defined in: src/index.ts:17

Custom user agent string for API requests (defaults to "@relatiohq/opencloud")

---

baseUrl?

optional baseUrl: string;

Defined in: src/index.ts:19

Base URL for the Roblox API (defaults to "https://apis.roblox.com")

---

retry?

optional retry: HttpRetry;

Defined in: src/index.ts:21

Retry configuration for failed requests

---

fetchImpl()?

optional fetchImpl: {
  (input, init?): Promise<Response>;
  (input, init?): Promise<Response>;
};

Defined in: src/index.ts:23

Custom fetch implementation (useful for testing or custom environments)

Call Signature

(input, init?): Promise<Response>;

MDN Reference

Parameters

Parameter	Type
input	URL | RequestInfo
init?	RequestInit

Returns

Promise<Response>

Call Signature

(input, init?): Promise<Response>;

MDN Reference

Parameters

Parameter	Type
input	string | URL | Request
init?	RequestInit

Returns

Promise<Response>