Disquirer.js NPM

Disquirer.js

Purpose

This library creates an interactive experience between a user and a Discord bot. You could compare the front-end of it to something like Inquirer.js disquirer.js

Installation

NPM: npm install disquirer.js. Yarn: yarn add disquirer.js.

Usage

Disquirer is written in TypeScript so enjoy the typings. Create a new Disquirer object and return answers:

import { Disquirer } from "disquirer.js";
import { Question } from "disquirer.js";
import { Settings } from "disquirer.js";

// Pass an array of questions as argument, and optionally a Settings object.
// These are the default settings if you don't set a Settings object.
const settings = {
  invalidAnswerMessage: "Not a valid answer.",
  invalidAnswerDeletionTime: 5000,
  invalidReactionMessage: "You didn't add a valid reaction.",
  invalidReactionDeletionTime: 5000
} as Settings;
// For the text argument in the Question object, you can also pass a RichEmbed.
// You can add a filter to each question to check if it fits certain criteria. This filter is in the form of a function.
// in this example, it checks if the length of the answer is equal to 1.
const questions = [
  { text: "Testing one question.", reactionMethod: "reaction", possibleAnswers: ["Ok"], filter: (answer) => answer.response.length === 1 }
] as Question[];
const disquirer = new Disquirer(questions, settings);

// TEXT_CHANNEL is an object of type TextChannel, USER is an object of type User from discord.js.
const answers = await disquirer.createPrompt(TEXT_CHANNEL, USER);

Disquirer#createPrompt returns a Promise containing an array of Answers. Documentation for the Question and Answer interfaces can be found here for Answer and here for Question For more examples, please refer to the test file,

TODO:

Tests

To run tests, fill in the required values in .env. To get this file, simply move .env.example to .env. Tests run in Discord and thus require user interaction there.

Documentation

Documentation can be found here.

Contributing

Feel free to contribute to the project, the code's a bit messy though but you can change that. To start, fork this, make your changes, and make a pull request. Please use prettier to format your code (should be automatically run on commit.) Found a bug? Report it as an issue. Join the project related Discord guild.