Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/distype/distype
A Discord library written in TypeScript for developers looking to interface directly with the Discord API with little to no abstractions.
https://github.com/distype/distype
api bot client discord discord-api discord-bot discordapp distype nodejs typescript
Last synced: 7 days ago
JSON representation
A Discord library written in TypeScript for developers looking to interface directly with the Discord API with little to no abstractions.
- Host: GitHub
- URL: https://github.com/distype/distype
- Owner: distype
- License: apache-2.0
- Created: 2021-11-22T14:19:21.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-06-29T20:09:52.000Z (over 1 year ago)
- Last Synced: 2024-02-09T07:44:52.656Z (9 months ago)
- Topics: api, bot, client, discord, discord-api, discord-bot, discordapp, distype, nodejs, typescript
- Language: TypeScript
- Homepage: https://distype.github.io/distype
- Size: 2.54 MB
- Stars: 7
- Watchers: 0
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## About
A Discord library written in TypeScript for developers looking to interface directly with the [Discord API](https://discord.com/developers/docs/intro) with little to no abstractions.
### Features
- **Lightweight:** Distype uses minimal dependencies, and is highly performant due to the absence of transforming raw data from Discord into complex structures and abstractions.
- **Scalable:** With a built-in sharding manager (that supports big bot sharding) and a focus on performance, Distype makes it easy to scale your bot.
- **Predictable:** Distype is as close as you can get to the Discord API, meaning that typically, what you see in Discord's documentation is also here.
- **Modular:** The cache manager, gateway manager, and rest manager can all be instantiated independently, allowing for super lightweight solutions.
- **Fully Featured:** Distype covers 100% of the Discord API, meaning that you'll never be missing out on any features.
- **Highly Configurable:** Distype aims to offer as much configuration as possible of its internals, such as fully controllable cache behavior, retry and rate limit behavior, custom rest and gateway base URLs for proxy solutions, access to low-level http and websocket options, and more.
### Links
- **[Docs](https://distype.br88c.dev/)**
- **[NPM](https://www.npmjs.com/package/distype)**
- **[GitHub](https://github.com/distype/distype)**
### Related Packages
- **[@distype/cmd](https://github.com/distype/cmd):** A command handler for Distype.
- **[@distype/lavalink](https://github.com/distype/lavalink):** A Lavalink wrapper with native bindings to Distype.
## Example Bot
```ts
// Import Distype and logging typings.
import { Client, LogCallback } from 'distype';
// Distype pushes logging events through callbacks, and allows you to define your own logger.
const logger: LogCallback = (message, { level }) => console.log(`${level} | ${message}`);
// Creates the client. The client creates a cache, gateway, and rest manager. The first parameter is your
// bot's token, followed by client options, then finally the log callback.
const client = new Client(YOUR_BOT_TOKEN, {}, logger);
// This connects the client to the gateway.
client.gateway.connect();
```
> Note that Discord API typings are for API version `10`, and are from [discord-api-types](https://www.npmjs.com/package/discord-api-types). While you can still specify different API versions to be used, it is not recommended.
## Installation
Distype can be installed via npm.
```sh
npm install distype
```
### Prerequisites
- **[Node.js >=18.14.0](https://nodejs.org/)**
- **[NPM >=9.3.1](https://www.npmjs.com/)**
### Optional packages
- **[bufferutil](https://www.npmjs.com/package/bufferutil/):** Improves ws performance.
- **[utf-8-validate](https://www.npmjs.com/package/utf-8-validate/):** Improves ws performance.
