Skip to main content
Deno 2 is finally here 🎉️
Learn more
Module

x/dynablox_opencloud/src/clients/BaseClient.ts>BaseClient

A Roblox OpenCloud API wrapper for Deno and NodeJS written in TypeScript.
dynabloxjs/dynablox_opencloud
Latest
class BaseClient
import { BaseClient } from "https://deno.land/x/dynablox_opencloud@v0.2.2/src/clients/BaseClient.ts";

The BaseClient for the API client. This is to be extended by other clients.

Includes the barebone structure for all API clients.

Constructors

new
BaseClient(options: BaseClientOptions)

Constructs a new BaseClient with the credentials, environmentURLOptions, and aliases.

Properties

readonly
authenticationType

The authentication type of the BaseClient.

readonly
credentials: RESTClientAuthentication
readonly
rest: RESTController

The RESTController to be used in the entirety of the client. It is used for requesting data and managing data.

readonly
services: Services

The services that utillize the RESTController and have their own methods for interacting with the Roblox web API.

Methods

setCredentialsValue(credentials: ClientAuthentication["value"]): void

Set the current credentials value.

setDefaultHeaders(headers: Record<string, string> | Headers): void

Set the default headers from the RESTController.