keiryojs / keiryo

🚀 a distributed discord library

---

NeoCord is currently in alpha, meaning it will probably be broken and might not work. If you want to contribute, please join our support server - It would be greatly appreciated.

Table of Contents

• about
• installation
  • optional packages
  • basic usage

About

Neocord is a powerful and feature-rich discord library.

• Flexible: Gives you the ability to extend specific structures, customize caching to your needs.
• Coverage: Covers the Discord Gateway, API, CDN, and in the near future, Voice.
• Caching: Boasts the most powerful and flexible caching solution across most discord libraries.

Installation

As of 09/04/2020 (month/day/year), NeoCord can only be used with node.js v12 and up.

yarn add neocord

Optional Packages

These are some optional packages you can install.

• Install zlib-sync or pako for data compression and inflation

  • zlib-sync
  • pako
  • or the native zlib module (no installation)

• erlpack for significantly faster websocket (de)serialization.

• bufferutil for a much faster websocket connection.

  And utf-8-validate for faster websocket processing.

Basic Usage

(typescript)

import { Client } from "neocord";

const client = new Client();

client
  .on("ready", () => console.log("Now ready!"))
  .on("messageCreate", (message) => {
    if (message.author.bot) return;

    const mentionPrefix = new RegExp(`^<@!${client.user.id}>\s*`);

    let prefix;
    if (message.content.startsWith("!")) prefix = "!"
    else {
      const mentioned = mentionPrefix.exec(message.content);
      if (!mentioned) return;
      prefix = mentioned[0]; 
    }
    
    const [cmd] = message.content.slice(prefix.length).split(/ /g);
    if (cmd.toLowerCase() === "ping") {
      message.channel.send("**Pong!**");
    }

    return;
  });


client.connect("your token here"); 

Links

• Support Server: discord.gg/5WD9KhF
• Github: https://github.com/neo-cord/neocord
• NPM: https://npmjs.com/neocord/

---

melike2d © 2020

keiryo's Issues

Caching Engines

As of right now, neocord only has support for memory caching... I'd like to add ways to use different methods like redis, mongodb, or any other database. But I have no idea how to do so.

Setup?

This is how I would like it to look (typescript):

import { Client, DiscordStructure } from "neocord";
import { RedisDataEngine, Sweepers } from "@neocord/engines";

const client = new Client({
  data: {
    engines: [
      new RedisDataEngine({
        handles: new Set()
          .add(DiscordStructure.Message)
          .add(DiscordStructure.Presence)
        sweepers: {
          [DiscordStructure.Message]: Sweepers.Message({
            lifetime: "30m",
            interval: "5m"
          })
        }
      })
    ]
  }
});

So here we have imported the Client and DiscordStructure.

The DiscordStructure enum is used to identify structures that can be cached within neocord like a Message, Role, etc...

We have also imported the Redis Data Engine and the Sweepers object.

The sweepers object contains pre-made sweepers for some of the structures.

In this case the redis data engine caches messages/presences and everything else will be stored within memory. I've also declared the sweepers option, only enabling a message sweeper which gets ran every 5 minutes and checks whether the message is older than 30 minutes and if it is it will be removed from the redis cache.

---

This is all just a very cool concept that might come to life but until there are more contributors this wont happen for quite a while.

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Edited/Blocked

These updates have been manually edited so Renovate will no longer make changes. To discard all commits and start over, click on a checkbox.

• Update actions/checkout action to v3
• Update actions/setup-node action to v3
• Update dependency eslint to v8

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• Update dependency discord-api-types to ^0.37.0
• Update dependency @types/node to v18
• Update dependency jsdoc to v4
• Update dependency typescript to v5
• Update typescript-eslint monorepo to v5 (major) (@typescript-eslint/eslint-plugin, @typescript-eslint/parser)
• Click on this checkbox to rebase all open PRs at once

Ignored or Blocked

These are blocked by an existing closed PR and will not be recreated unless you click a checkbox below.

• Update dependency @neocord/utils to v1.1.4
• Update dependency @neocord/rest to v2

Detected dependencies

github-actions

.github/workflows/lint.yml

• actions/checkout v2
• actions/setup-node v1

npm

package.json

• @neocord/gateway ^1.2.3
• @neocord/rest ^1.2.0
• @neocord/utils 1.0.15
• discord-api-types ^0.5.0
• tslib ^2.0.1
• @types/node ^14.11.2
• @typescript-eslint/eslint-plugin ^4.3.0
• @typescript-eslint/parser ^4.3.0
• eslint ^7.10.0
• jsdoc ^3.6.6
• prettier ^2.1.2
• typescript ^4.0.3

---

• Check this box to trigger a request for Renovate to run again on this repository