Skip to main content
Module

x/tpy/mod.ts>Tpy

🔑 A strongly typed Pylon API client.
insyri/tpy
Latest
class Tpy
Re-export
import { Tpy } from "https://deno.land/x/tpy@v1.0.0-RC/mod.ts";

The central entity for interacting with the Pylon API; the entrypoint.

Constructors

new
Tpy(options: { deploymentID?: string; useNodeFetch?: boolean; token: string; })

Properties

private
readonly
token: string
readonly
optional
deploymentID: string

A default deployment ID used to occupy deploymentID parameter entries.

Methods

connectSocket(deploymentID?: string)

Connects to the Pylon workbench WebSocket.

getAvailableGuilds()

Gets all the guilds the user is in.

getDeployment(deploymentID?: string)

Gets the deployment information.

getDeploymentIDfromGuild(guildID: string)

Gets the most recent deployment ID from a guildID.

getEditableGuilds()

Gets all guilds a user can edit with Pylon. More specifically, all guilds which the user is an administrator.

getGuildInfo(guildID: string)

Gets the raw Discord guild information with deployment information.

getGuildStats(guildID: string)

Gets the guild computational statistics.

getNamespaceItems<T>(namespace: string, deploymentID?: string): Promise<KV.GET.ItemsFlattened<T> | undefined>

Gets all the namespace items under the given deployment ID.

getNamespaces(deploymentID?: string)

Gets all the namespaces under the given deployment ID.

getUser()

Gets the user's account details associated with the included credentials.

httpRaw<T>(
ctx: Context,
resource: string,
cases?: Cases,
method?: HTTPVerbs,
requestInit?: RequestInit,
): Promise<T>

Makes a request to the API and creates possible errors according to the response.

KV(namespace: string, deploymentID?: string)

Creates a new TpyKV instantiation, much like the Pylon SDK's KVNamespace class.

publishDeployment(body: Deployment.POST.Request<false>, deploymentID?: string)

Makes a POST request to publish a deployment; returns details of the new deployment.

readyRequest(method: HTTPVerbs, other?: RequestInit): RequestInit

A factory function with default headers, allowing optional specificity.