seyfert/README.md
Marcos Susaña 843765647c
Update README.md
resolve import problem
2022-07-30 14:07:07 -04:00

1.5 KiB

biscuit

A brand new bleeding edge non bloated Discord library

biscuit

Install (for node18)

npm install @biscuitland/core
yarn add @biscuitland/core

for further reading join our Discord

Most importantly, biscuit is:

  • A wrapper to interface the Discord API
  • A bleeding edge library

Biscuit is primarily inspired by Discord.js and Discordeno but it does not include a cache layer by default, we believe that you should not make software that does things it is not supposed to do.

Why biscuit?:

  • Minimal, non feature-rich!
  • Scalable

Example bot (TS/JS)

import { Session } from '@biscuitland/core';
import { GatewayIntents } from '@biscuitland/api-types';

const intents = GatewayIntents.MessageContent | GatewayIntents.Guilds | GatewayIntents.GuildMessages;
const session = new Session({ token: 'your token', intents });

session.events.on('ready', ({ user }) => {
    console.log('Logged in as:', user.username);
});

session.events.on('messageCreate', (message) => {
    if (message.content.startsWith('!ping')) {
        message.reply({ content: 'pong!' });
    }
});

session.start();

Known issues:

  • node18 is required to run the library, however --experimental-fetch flag should work on node16+
  • redis cache (wip)
  • no optimal way to deliver a webspec bun version to the registry (#50)