seyfert
Version:
The most advanced framework for discord bots
74 lines (52 loc) • 2.3 kB
Markdown
<div align='center'>
<img src="./assets/icon.png" alt="seyfert" width="200px" />
**Seyfert is a brand-new Discord framework to take the bot development to a next level**
[](https://github.com/tiramisulabs/seyfert/blob/main/LICENSE)
[](https://www.npmjs.com/package/seyfert)
[](https://discord.com/invite/XNw2RZFzaP)
</div>
## FAQ
### So, what is `seyfert`?
Seyfert is the ultimate Discord framework! We make it easy to interact with the Discord API, big cache control, scalable code and a pretty dev experience.
### Why should I use it?
There are many reasons to use Seyfert, but they dont all fit in this tiny readme, so here is a list of the most awesome reasons!
- **Low RAM Usage**
- **Latest features**
- **Dev experience**
- **24/6 support (Sunday is for church)**
- **Written from Scratch**
- **Type-safe**
- **And many more!!**
## Installation
> [!NOTE]
> Node v18>= is required (or v16 with `--experimental-fetch` flag), Bun/Node LTS recommended.
```sh
pnpm add seyfert
```
```sh
deno add npm:seyfert
```
```sh
bun add seyfert
```
```sh
npm i seyfert
```
> Or other package manager.
## Contributing
We are open to contributions, fork the repo and make your changes!
## Typed errors
Seyfert throws `SeyfertError` in validation/runtime checks and can include:
- `code`: machine-readable identifier (`INVALID_EMOJI`, `INVALID_OPTIONS_LENGTH`, `MISSING_COMPONENT`, etc.)
- `metadata`: structured context for diagnostics
For validation errors, metadata follows this convention:
- `expected`: expected value/shape
- `received`: value actually received
- `receivedType`: optional primitive/runtime type
## Useful links
- [GitHub Repository](https://github.com/tiramisulabs/seyfert)
- [Discord server](https://discord.com/invite/XNw2RZFzaP)
- [npm - core](https://www.npmjs.com/package/seyfert)
- [Website](https://seyfert.dev)
- [Documentation](https://seyfert.dev/guide)
