niboh v1.0.17

niboh

Niboh is a library that provides powerful collectors for Discord Bots made using Discord.js library.

It allows you to collect almost every type of information, from a ButtonInteraction to a TextInput (message sent in the specified channel)

How to install

yarn add niboh
npm install niboh
pnpm install niboh

Example

Collecting a ButtonInteraction from a message

import { ButtonSelectCollector } from 'niboh'

const messageComponents = [
  new ActionRowBuilder<ButtonBuilder>().setComponents(
    new ButtonBuilder()
      .setCustomId('cool-id')
      .setLabel('Confirm')
      .setButtonStyle(ButtonStyle.Success)
  )
]

const message = await someCoolInteraction.reply({
  fetchReply: true,
  components: messageComponents
})

const buttonSelectCollector = new ButtonSelectCollector({
  location: message.channel,
  target: someCoolInteraction.user
})

const buttonInteraction = await buttonSelectCollector.setProps({ message }).run()

if (buttonInteraction) {
  buttonInteraction.reply({ content: 'Confirmed!' })
}

Make sure to understand that the only part of the library that is actually being used is here

const buttonSelectCollector = new ButtonSelectCollector({
  location: message.channel,
  target: someCoolInteraction.user
})

const buttonInteraction = await buttonSelectCollector.setProps({ message }).run()

if (buttonInteraction) {
  buttonInteraction.reply({ content: 'Confirmed!' })
}

the rest is only a example of message sent with some components to be collected :)

Combined Collectors

You can combine collectors to run at the same time, but how can it be useful? You might want to run a ButtonCollector with a TextInputCollector, for example, imagine you want to ask a user to confirm an operation, so the user can confirm by clicking or writing a specific text.

import { ButtonSelectCollector, TextInputCollector, CombineCollectors } from 'niboh'

const buttonSelectCollector = new ButtonSelectCollector({
  location: message.channel,
  target: someCoolInteraction.user
}).setProps({ message })

const textInputCollector = new TextInputCollector({
  location: message.channel,
  target: someCoolInteraction.user
}).setProps({ pattern: /^confirm$/ })

const combinedCollectors = new CombineCollectors([
  buttonSelectCollector,
  textInputCollector
])

const result = await combinedCollectors.run()

if (result.isButtonSelectInteraction()) {
  const buttonInteraction = result.value
  //   ^ ? = ButtonInteraction | null
}

if (result.isTextInput()) {
  const textInput = result.value
  //   ^ ? = string | null
}