README.md

Jarvis

Javascript Discord Lib For Interacting With The Discord API!

This Is Not Fully Working! Please Do Not Donwload and Complain Because This Is a Work In Progress! PR Welcomed!

Table of Contents

• Support Server
• Requirements
• Installation
• Usage
• Events
• Discord Gateway

Requirements

• Node.JS => 14.0.0

Installation

NPM (recommended)

# Stable
npm i --save jarvis.djs

# Nightly Builds
npm i --save jarvis.djs@nightly

Yarn

# Stable
yarn add jarvis.djs

# Nightly Builds
yarn add jarvis.djs@nightly

Usage

Import the lib via ES6 or commonJS modules

// ES6
import * as discord from "jarvis.djs";
// or commonJS
const discord = require("jarvis.djs");

Client

const discord = require('jarvis.djs');
const client = new discord.Client({
    guild_subscriptions: false,
    intents: 32509,  // https://ziad87.net/intents/
    presence: "online",
    status: {
        text: "Status Text",
        type: 0 // Types: 0 = Playing, 1 = Streaming, 2 = Listening
    },
    ws: {
      large_threshold: 250,
      compress: false
    }
});

// Add This Before Anything Else
client.login("TOKEN");

client.on("ready", async() => {
    console.log("Ready!")
});

client.on("message", async (message) => {
    console.log(message.content);
});

Client Methods

Destroy Client:

client.destroy(); // Will destroy the client along with the discord connection

Ready Timestamp:

client.readyAt();

Manual REST Request:

client.manualREST("https://discordapp.com/api/v8/gateway", "GET", {
    'Content-Type': 'application/json',
    'authorization': 'Bot <TOKEN>'
});

Fetch Guild:

client.fetchGuild("ID").then(res => {
    console.log(res);
});

Create Guild:

client.createGuild(name, region, icon).then(res => {
    console.log(res);
});

Events

Ready Event:

ready - When Client Is Ready
warn - Warnings
error - When There Is An Error

Discord Gateway

This is the connection between the client and discord api servers.

License