Skip to main content
Module

x/dynablox_opencloud/mod.ts>OpenCloudClientOptions

A Roblox OpenCloud API wrapper for Deno and NodeJS written in TypeScript.
Latest
interface OpenCloudClientOptions
import { type OpenCloudClientOptions } from "https://deno.land/x/dynablox_opencloud@v0.2.2/mod.ts";

OpenCloudClient options.

Properties

credentialsValue: string

The API Key credential value.

optional
scopes: Scope[]

Allowed scopes to be used by the client.

optional
ratelimiter: RatelimitHelper

The ratelimiter helper function.

optional
ratelimiterSubjectId: number

The subject ID for the ratelimiter.

optional
ratelimiterShouldYield: boolean

Whether the ratelimiter should yield instead of throwing an error.

optional
requestRetryTimeout: number

Retry timeout for 500, 502, and 504 responses in milliseconds.

optional
requestRetryCount: number

Retry count for 500, 502, and 504 responses.

Base options.