APIClient | /mod.ts | revolt_api@0.4.0

Module

x/revolt_api/mod.ts>APIClient#fetch

a typed revolt api client

brecert/revolt-api

Latest

scripts

mod.ts (default module)

Bot

CreateVoiceUserResponse

DataDefaultChannelPermissions

DataResendVerification

DataSendPasswordReset

DataSetServerDefaultPermission

DataSetServerRolePermission

SystemMessageChannels

method APIClient.prototype.fetch

import { APIClient } from "https://deno.land/x/revolt_api@0.4.0/mod.ts";

fetch<Name extends APIRoutes["name"], Routes extends APIRoutes & { name: Name; }, Path extends Routes["path"], Route extends Routes & { path: Path; }, RequiredInit extends RequireNonNull<Pick<Route, "query" | "body">>, Init extends Omit<ExtendRequestInit<RequiredInit>, "method">>(...unnamed 0: Route extends { method: "get"; query: never; body: never; } ? [Name, Path, Init] : [Name, Path, Init]): Promise<TypedResponse<Route["response"]>>

Send a typed arbitrary request.

Examples

Example 1

const config = await api.fetch('Query Node', '/').then(res => res.json());
console.log(`The API is running revolt ${config.revolt}`);

Type Parameters

Name extends APIRoutes["name"]

Routes extends APIRoutes & { name: Name; }

Path extends Routes["path"]

Route extends Routes & { path: Path; }

RequiredInit extends RequireNonNull<Pick<Route, "query" | "body">>

Init extends Omit<ExtendRequestInit<RequiredInit>, "method">

Parameters

...unnamed 0: Route extends { method: "get"; query: never; body: never; } ? [Name, Path, Init] : [Name, Path, Init]

Returns

Promise<TypedResponse<Route["response"]>>

Typed response data