Bot owner only commands

Some commands should only be available to the bot owners. A perfect example of this is a "status" command that updates the status of your bot. NYXBCommands comes with this capability.

Here is how your command file should be setup:

Typescript
import { ActivityType, Client } from 'discord.js'
import { CommandObject, CommandType, CommandUsage } from '@nyxb/commands'

function setStatus(client: Client, status: string) {
  client.user?.setPresence({
    status: 'online',
    activities: [
      {
        name: status,
        type: ActivityType.Playing,
      },
    ],
  })
}

export default {
  description: 'Sets the bot\'s status',

  type: CommandType.BOTH,

  minArgs: 1,
  expectedArgs: '<status>',

  ownerOnly: true,

  callback: (options: CommandUsage) => {
    const { client, text } = options
    setStatus(client, text)

    return {
      content: `Set status to "${text}"`,
    }
  },
} as CommandObject
Javascript
const { CommandType } = require('@nyxb/commands')

function setStatus(client, status) {
  client.user?.setPresence({
    status: 'online',
    activities: [
      {
        name: status,
        type: ActivityType.Playing,
      },
    ],
  })
}

module.exports = {
  description: 'Sets the bot\'s status',

  type: CommandType.BOTH,

  minArgs: 1,
  expectedArgs: '<status>',

  ownerOnly: true,

  callback: ({ client, text }) => {
    setStatus(client, text)

    return {
      content: `Set status to "${text}"`,
    }
  },
}

Whenever we initialize NYXBCommands we can pass in any number of IDs for the owner's Discord accounts:

The bot owner's ID is automatically added to the bot owner list. If you are the only developer working on your project you do not need to add your ID.
Typescript
import path from 'node:path'
import { Client, IntentsBitField, Partials } from 'discord.js'
import NYXB from '@nyxb/commands'
require('dotenv/config')

const client = new Client({
  intents: [
    IntentsBitField.Flags.Guilds,
    IntentsBitField.Flags.GuildMessages,
    IntentsBitField.Flags.DirectMessages,
    IntentsBitField.Flags.MessageContent,
  ],
  partials: [Partials.Channel],
})

client.on('ready', () => {
  console.log('The bot is ready')

  new NYXB({
    client,
    commandsDir: path.join(__dirname, 'commands'),
    botOwners: ['Your_ID_Here']
  })
})

client.login(process.env.TOKEN)
Javascript
const path = require('node:path')
const NYXB = require('@nyxb/commands')
require('dotenv/config')

const client = new Client({
  intents: [
    IntentsBitField.Flags.Guilds,
    IntentsBitField.Flags.GuildMessages,
    IntentsBitField.Flags.DirectMessages,
    IntentsBitField.Flags.MessageContent,
  ],
  partials: [Partials.Channel],
})

client.on('ready', () => {
  console.log('The bot is ready')

  new NYXB({
    client,
    commandsDir: path.join(__dirname, 'commands'),
    botOwners: ['Your_ID_Here']
  })
})

client.login(process.env.TOKEN)
Edit this page on GitHub