npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@kamuridesu/whatframework

v0.1.54-b

Published

A simple WhatsApp Bot Framework on top of Baileys

Downloads

79

Readme

WhatFramework

An extensible Framework for WhatsApp!

Getting started

Installing the framework

  1. Create a new folder and start the project with npm init
  2. Install WhatFramework: npm install --save @kamuridesu/whatframework

Creating your EntryPoint file

WhatFramework needs modules to work. A module is made of a file called entrypoint.js file, which has a class Entrypoint that has some properties and methods used by the Framework to define how the bot will handle commands and messages.

Parameters

The following parameters are needed to start the framework:

  1. prefix: the commands prefix for your bot;
  2. name: the name of the bot;
  3. botNumber: the number of the bot;
  4. ownerNumber: Number of the bot owner;

Optional parameters:

  1. language: Language of the bot. Defaults to en-us;
  2. commandsFilename: Name of the commands file. The reason for this will be explained later.

Methods

We need to define at least the two following methods in our Entrypoin class:

  1. chatHandlers: Handles any message received by the bot, except those who start with the prefix property.
  2. commandHandlers: Handles any message that starts with the prefix property.

Each method will have a different signature:

chatHandlers must have the following parameters:

  • bot: a bot instance;
  • message: a string with the message;
  • context: a MessageData instance containing all the data for that message;
  • group: a GroupData instance holding all the data for a group. If the chat is not a group, the value is undefined;
  • metadata: a ChatMetadata instance containing some meta info for the chat.

commandHandlers must have the following parameters:

  • bot: a bot instance;
  • command: a string with the command;
  • args: command arguments, if any;
  • context: a MessageData instance containing all the data for that message;
  • group: a GroupData instance holding all the data for a group. If the chat is not a group, the value is undefined;
  • metadata: a ChatMetadata instance containing some meta info for the chat.

You can see an example in examples.

Helpers

The framework have some libs to help the developer to build their bots.

Helper libs will be available in whatframework/libs/.

Running

After installing WhatFramework and creating your module with the entrypoint, just run the following command:

npx whatframework

You'll be prompted to scan a QR code to login with a phone number. Scan the code and the bot will start.