@voidedhost/sdk
v0.1.0
Published
Official TypeScript/JavaScript SDK for voided.host
Maintainers
Readme
@voidedhost/sdk
Official TypeScript/JavaScript SDK for voided.host.
Requirements
- Node.js 18 or higher
- A voided.host token
Install
npm install @voidedhost/sdkUsage
import { VoidedHost } from "@voidedhost/sdk";
const voided = new VoidedHost("YOUR_API_TOKEN");
// Users
const user = await voided.users.fetch(1);
await voided.users.edit(user, { username: "Lixqa1" });
// Images
const image = await voided.images.fetch(1234);
await voided.images.edit(image, { title: "New Title", description: "New Description" });
// Badges
const badges = await voided.badges.fetch();
for (const badge of badges.values()) {
console.log(badge.name, badge.url);
}API overview
| Export | Description |
| ------------------------ | ----------------------------------- |
| VoidedHost | Main client; accepts an API token. |
| voided.users | User manager (fetch, edit, cache). |
| voided.images | Image manager (fetch, edit, cache). |
| voided.badges | Badge manager (fetch, cache). |
| voided.api | Low-level generated API client. |
| User, Image, Badge | Structure classes. |
| CDN_BASE_URL | CDN base URL constant. |
License
See LICENSE. Use of this SDK is permitted only for integrating with voided.host.
