gearhandler v1.0.7

Gear handler

Examples

• Index

  const { GearClient } = require('gearhandler');
  
  const client = new GearClient({
    intents: <Intents>,
    commandPath: __dirname + '/commands',
    eventPath: __dirname + '/events'
  });
  
  client.on('ready',() => {
    client.Setup({
      RegisterCommands: true,
      HandleCommands: true,
      Events: true
    });
  });
  
  client.login(<TokenH>);

• Command

  const { CreateCommand } = require('gearhandler');
  
  module.exports = new CreateCommand({
    category: <CategoryName>
    name: <CommandName>,
    description: <CommandDescription>,
  
    run: ({ //async can be via "async({"
      client,
      interaction,
      args
    }) => {
      interaction.reply({ content: '<Message>' });;
    }
  });

• Event

  const { CreateEvent } = require('gearhandler');
  
  module.exports = new CreateEvent({
    event: <EventName>,
  
    run: ({ //async can be via "async({"
      client,
      data
    }) => {
      console.log('Found Event!');
    }
  });

• Index

  import { GearClient } from 'gearhandler';
  
  const client: GearClient = new GearClient({
    intents: <IntentsHere>,
    commandPath: __dirname + '/commands',
    eventPath: __dirname + '/events'
  });
  
  client.on('ready', () => {
    client.Setup({
      RegisterCommands: true,
      HandleCommands: true,
      Events: true
    });
  });
  
  client.login(<TokenHere>);

• Command

  import { CreateCommand } from 'gearhandler';
  
  export default new CreateCommand({
    category: <CategoryName>
    name: <CommandName>,
    description: <CommandDescription>,
  
    run: ({ //async can be via "async({"
      client,
      interaction,
      args
    }) => {
      interaction.reply({ content: <Message> });
    }
  });

• Event

  import { CreateEvent } from 'gearhandler';
  
  export default new CreateEvent({
    event: <EventName>,
  
    run: ({ //async can be via "async({"
      client,
      data
    }) => {
      console.log('Found Event!');
    }
  });

Classes

• DB?: BetterSQLite3.Database
• Developers?: String[]
• DevGuild?: string
• EventPath?: string
• CommandPath: string
• & ClientOptions

• commands: Collection\<string, ICommandType>

• events: Collection\<string, IEventType>

• userCooldowns: Collection\<string, Collection\<UserResolvable, number>>

• guildCooldowns: Collection\<string, Collection\<GuildResolvable, number>>

• db: BetterSQLite3.Database

• registry: {developers: string[], devGuild: string, commandPath: string, eventPath: string}

• login

  • token?: string

  • Returns: Promise\<string>

• Setup

  • RegisterCommands?: boolean
  • HandleCommands?: boolean
  • Events?: boolean

  • Returns: Promise\<void>

• getBotUser

  • Returns: Promise\<User>

• getBotTag

  • Returns: Promise\<string>

• getBotUsername

  • Returns: Promise\<string>

• getBoDiscrim

  • Returns: Promise\<string>

• getUserCreationTimestamp

  • user: User

  • Returns: Promise\<number>

• getUserCreationDate

  • user: User

  • Returns: Promise\<>

• getUserBanStatus

  • guild: Guild
  • user: User

  • Returns: Promise\<{Status: string, Reason: string, Ban: GuildBan | string}>

• dbGet

  • key: string

  • Returns: Promise\<any>

• dbSet

  • key: string
  • value: any

  • Returns: Promise\<BetterSQLite3.RunResult>

• dbDelete

  • key: string

  • Promise\<any>

• category: string
• userCooldown?: number
• guildCooldown?: number
• requiredPermissions?: PermissionResolvable[]
• requiredRoles?: string[]
• bannedRoles?: string[]
• ownerOnly?: boolean
• developerOnly?: boolean
• nsfw?: boolean
• run:
  • client: GearClient
  • interaction: CommandInteraction
  • args: readonly CommandInteractionOption\<CacheType>
• & ChatInputApplicationCommandData

• event: string
• run:
  • client: GearClient
  • data: any