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

rgrefer

v1.0.5

Published

An easy to use referral system implmentation library for grammy

Downloads

13

Readme

rgrefer

rgrefer is a middleware library for the grammy bot library, designed to facilitate the implementation of a referral system in your bot.

Installation

You can install rgrefer via npm:

npm install rgrefer

Usage

JavaScript Example

const { Bot } = require("grammy");
const refer = require("rgrefer/cjs"); // Or import("rgrefer")

const bot = new Bot("YOUR_BOT_TOKEN");

// Define your bot's options
const options = {
  referrerBonus: 10,
  referreeBonus: 5,
  startupBonus: 20,
  userExists: async (id) => {
    // Your logic to check if a user exists in the database
  },
  addBalance: async (id, amount) => {
    // Your logic to add balance to a user
  },
  onReferral: async (referrer, referree) => {
    // Your logic to handle referral events
  },
  onStartUp: async (ctx) => {
    // Your logic to handle bot startup events
  },
};

// Use the middleware in your bot
bot.use(refer(options));

// The rest of the code goes here

TypeScript Example

import { Bot } from "grammy";
import refer from "rgrefer";

const bot = new Bot("YOUR BOT TOKEN");

// Use the middleware in your bot
bot.use(refer({
  referrerBonus: 10,
  referreeBonus: 5,
  startupBonus: 20,
  userExists: async (id?: number) => {
    // Your logic to check if a user exists in the database
  },
  addBalance: async (id?: number, amount?: number) => {
    // Your logic to add balance to a user
  },
  onReferral: async (referrer: number, referree: Context) => {
    // Your logic to handle referral events
  },
  onStartUp: async (ctx: Context) => {
    // Your logic to handle bot startup events
  },
}));

CommonJS Version

If you need to use the CommonJS version of rgrefer, you can find it in the rgrefer/cjs directory.

const refer = require("rgrefer/cjs");
// Usage remains the same as shown in the JavaScript example above

License

This project is licensed under the MIT License - see the LICENSE file for details.