Nuclearly Potent Moonshine

npm

Need private packages and team management tools?Check out npm Orgs. »

parrot-bot

1.0.5 • Public • Published

parrot-bot

parrot-bot

Support me on Patreon Buy me a book PayPal Ask me anything Version Downloads Get help on Codementor

Buy Me A Coffee

A parrot-like bot you can talk with.

Online demo

You can talk to the Parrot, by visiting parrot.ionicabizau.net. See below how to use it.

How it works

The Parrot Bot doesn't know anything in the beginning. You have to teach them to give answers. The answers you will eventually get from the bot will be your own words, hence the name: Parrot Bot. 🐦

Enjoy! 🎉

☁️ Installation

# Using npm 
npm install --save parrot-bot
 
# Using yarn 
yarn add parrot-bot

📋 Example

const Parrot = require("parrot-bot");
 
// Create a new bot
let bot = new Parrot("en");
 
// Catch the error
bot.on("error", err => console.error(err));
 
// Try to solve this planet's problems
console.log(bot.tellSync("How many people are in the world?"));
// => I don't know to answer this questin.
 
// Teach this robot, so next time we will know what to do
bot.tellSync("There are 7 billion people on this planet.");
 
// Ask him again
console.log(bot.tellSync("How many people are in the world?"));
// => You're repeating yourself.
 
// Clear the internal cache
bot.clearCache();
 
// Ask him again
console.log(bot.tellSync("How many people are in the world?"));
// => There are 7 billion people on this planet.
 
// Kill this bot (this will NOT kill his memory)
bot.die();

❓ Get Help

There are few ways to get help:

  1. Please post questions on Stack Overflow. You can open issues with questions, as long you add a link to your Stack Overflow question.

  2. For bug reports and feature requests, open issues. 🐛

  3. For direct and quick help, you can use Codementor. 🚀

📝 Documentation

ParrotBot(config, options)

Params

  • String|Object config: The bot language or the bot config itself.
  • Object options: An object containing the following fields:
  • database (Object): The database configuration:
    • name (String): The database name (default: parrotbot)
    • uri (String): The MongoDB uri.
    • collection (String): The collection name.
  • lang (String): The bot language. Supported: ro (Romanian), en (English). Feel free to extend this by adding new files in the lib/languages directory.

Return

  • ParrotBot The ParrotBot instance.

getWordsFromMessage(message)

Gets the words from the message, ignoring the words that should be ignored (configuredin the bot config).

Params

  • String message: The message to get the words from.

Return

  • Array The message words.

getFailMessage()

Returns a fail message (such as I don't know how to answer).

Return

  • String The message.

getDuplicateMessage(type)

Returns a message such as Hey, you have already asked me this!.

Params

  • String type: The message type.

Return

  • String The message.

getMessageType(message)

Returns the message type (question or answer).

Params

  • String message: The message.

Return

  • String A for answer, Q for question.

removeDiacritics(message)

Removes the diacritics from the message.

Params

  • String message: The message containing special characters.

Return

  • String The message without diacrtics.

getConfig()

Returns the config object.

Return

  • Object The config object.

tell(message, cb)

Tell something to the bot.

Params

  • String message: The message to send to the bot.
  • Function cb: The callback function.

processMessageToInsert(message)

Parse the message and prepare the database record.

Params

  • String message: The message to insert.

Return

  • Object An object containing:
  • type (String): The message type (A/Q).
  • message (String): The raw message.
  • meta (Array): The message words.

processMessageToSend(message, cb)

Answers a message, without remembering it.

Params

  • String message: The message to answer to.
  • Function cb: The callback function.

clearCache(cb)

Clears the internal cache.

Params

  • Function cb: The callback function.

remove(filters, options, cb)

Removes messages.

Params

  • Object filters: The query filters.
  • Object options: The query options.
  • Function cb: The callback function.

die()

Ends the connection to the database, but doesn't clear the memory (the database documents).

😋 How to contribute

Have an idea? Found a bug? See how to contribute.

💖 Support my projects

I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously, this takes time. You can integrate and use these projects in your applications for free! You can even change the source code and redistribute (even resell it).

However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:

  • Starring and sharing the projects you like 🚀

  • Buy me a book—I love books! I will remember you after years if you buy me one. 😁 📖

  • PayPal—You can make one-time donations via PayPal. I'll probably buy a coffee tea. 🍵

  • Support me on Patreon—Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).

  • Bitcoin—You can send me bitcoins at this address (or scanning the code below): 1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6

Thanks! ❤️

📜 License

MIT © Ionică Bizău

install

npm i parrot-bot

Downloadsweekly downloads

13

version

1.0.5

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability