discord-form-maker v0.0.1

Discord Form Maker

en-US

This package is designed to help you create forms on your Discord bot

Installation

npm i discord-form-maker --save

Example

//Start Bot
const Discord = require('discord.js')
const client = new Discord.Client()
client.login('Your token here!')

const DFM = require('discord-form-maker')

const Form = new DFM(client, 'Channel ID')

Form.makeQuestion('Question 1', 5000) //The 5000 is time!
Form.makeQuestion('Question 2', false) //Put false to not have a time!

Form.start('User ID!')//Start the form!

Form.on('response', r => { //When the user sends a reply!
console.log(r) //User response!
})

Form.on('finish', f => { //When the user finishes the form!
   console.log(f) 
   /*
   {
   responses: {
   'Question 1': 'User response',
   'Question 2': 'User response'
   },
   reason: 'completed' or 'time'
   }
   */
})

Properties:

.questions

type: array

return: array off questions

.responses

type: object

return: all the answers up to that moment

.times

type: object

return: the question times

Methods:

.makeQuestion(question, time)

question: string

time: number or boolean <false>

Form.makeQuestion('Question 1', 5000)
//or
Form.makeQuestion('Question 2', false)

.start(userId)

userId: string

Form.start('User ID')

Events:

.on('response', r)

r: string

Form.on('response', r => {
console.log(r) //User response!
})

.on('finish', f)

f: object

f.responses: object

f.reason: string

Form.on('finish', f => {
console.log(f) //Form result!
})

pt-BR

Este pacote foi feito para ajudar você a criar formulários no seu bot no Discord!

Instalação

npm i discord-form-maker --save

Exemplo

//Start Bot
const Discord = require('discord.js')
const client = new Discord.Client()
client.login('Seu token aqui!')

const DFM = require('discord-form-maker')

const Form = new DFM(client, 'ID do canal!')

Form.makeQuestion('Pergunta 1', 5000) //5000 = o tempo que o usuário terá para resolver!
Form.makeQuestion('Pergunta 2', false) //Coloque false para não ter um tempo!

Form.start('ID do usuário!')//Começe o formulário!

Form.on('response', r => { //Quando o usuário enviar uma resposta
console.log(r) //Resposta do usuário
})

Form.on('finish', f => { //Quando o usuário acabar o formulário!
   console.log(f) 
   /*
   {
   responses: {
   'Pergunta 1': 'Resposta do usuário',
   'Pergunta 2': 'Resposta do usuário'
   },
   reason: 'completed' ou 'time'
   }
   */
})

Propriedades:

.questions

tipo: array

retorna: array das questões

.responses

tipo: object

retorna: todas as respostas até aquele momento

.times

tipo: object

retorna: os tempos das perguntas

Métodos:

.makeQuestion(question, time)

question: string

time: number ou boolean <false>

Form.makeQuestion('Pergunta 1', 5000)
//ou
Form.makeQuestion('Pergunta 2', false)

.start(userId)

userId: string

Form.start('ID do usuário')

Eventos:

.on('response', r)

r: string

Form.on('response', r => {
console.log(r) //Resposta do usuário!
})

.on('finish', f)

f: object

f.responses: object

f.reason: string

Form.on('finish', f => {
console.log(f) //Resultado do formulário!
})