jericho-framework
TypeScript icon, indicating that this package has built-in type declarations

1.2.0 • Public • Published


Jericho Framework

About

Jericho-Framework is a Framework Build for Jericho Discord Bot Requirements and Other begineer Developers Jericho Discord Bot and is stable working with discord.js v13 discord.js v13.

  • Object-oriented
  • Customisable Handlers
  • Performant
  • 100% coverage of the discord.js v13

Installation

Node.js 15 or newer is required.

npm install jericho-framework

Optional packages

npm install discord.js@latest

Example usage

Register a Thread Handler for Discord API:

import { ThreadHandler } from 'jericho-framework';
const ChannelInstance = new ThreadHandler(Client, {
     guild : <GuildResolve>,
     channel: <ChannelResolve>,
     metdata: <Saved-Data> || null,
});
const ThreadInstance = ChannelInstance.CreateThread({
     metdata: <Saved-Data> || null,
     Name : <Thread-Name> || <Thread-Title>,
     AutoArchiveDuration : <Time-in-Seconds>,
     Type: <'private-thread'> || <'public-thread'>,
     Reason: <Reason-to-Create> || null,
     Channel: <if to Change Channel { ChannelResolve }>,
})

Get and Destroy Handler:

const ThreadInstances = ChannelInstance.GetThreadInstances(ThreadInstance.ThreadCode,<Amount of Instances>);

const DestroyThread = ChannelInstance.DestroyThread(ThreadInstance.ThreadCode,{
    Reason: <Reason-to-Create> || null,
    Delay: <Time-in-Seconds>,
});

Structure of Thread-Instance and Channel-Instance :

Thread Instance

{
    guild,
    channel,
    ThreadCode,
    Client,
    metadata,
    thread,
}

Channel Instance

{
    Client,
    ChannelCode
    guild,
    channel,
    Client,
    metadata,
}

Register a Slash Command Handler for Discord API:

import { SlashCommandHandler } from 'jericho-framework';
const SlashInstance = new SlashCommandHandler(Client, {
     guild : <GuildResolve>, || <message> | <channel> | <guild> | <guildId>
});
SlashInstance.set(<Array of Slash Commands>);
SlashInstance.deploy();
SlashInstance.destroy(<CommandId || null>);
SlashInstance.get(<CommandId || null>);

Structure of Slash Commands :

Slash Commands

{
    guild,
    SlashCommands,
    ApplicationCommands,
    global,
    Client,
}

Jericho-Framework Utilities : It can Support any Resolve including IDs too

Resolvers

const Channel = ChannelResolver(<Channel-Resolve>,{
  ifmessage: true,
  type:text
});

const Guild = GuildResolver(<Guild-Resolve>,{
  ifmessage: true,
});

Register a Void Handler for Discord API:

import { VoiceHandler } from 'jericho-framework'
const Voice_Handler = new VoiceHandler(Client, {
  LeaveOnEmpty: true,
})
Voice_Handler.disconnect()
Voice_Handler.destroy()
Voice_Handler.get()

Structure of Void Connection is Same as Connection in "@discordjs/voice"

Links

Contributing

Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the ReadMe.md

Help

If you don't understand something in the ReadMe.md , you are experiencing problems, or you just need a gentle nudge in the right direction, please don't hesitate to join our official Support Server.

Package Sidebar

Install

npm i jericho-framework

Weekly Downloads

2

Version

1.2.0

License

ISC

Unpacked Size

67.9 kB

Total Files

14

Last publish

Collaborators

  • sidislive