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

rw-api.js

v1.1.0

Published

A npm package to listen to votes on our website.

Downloads

22

Readme

RW-API.JS

RW-API.JS est un module permettant d'écouter les évents émis par notre site web. (Votes & Bump)

Comment le faire fonctionner

Etape 1: Configuration

Tout d'abord, vous allez avoir besoin de configurer le module sur le dashboard du serveur souhaité. Pour ce faire, connectez vous à notre site. Une fois connecté, cliquez sur votre pseudo en haut à droite, puis sur "Dashboard". Ici, choisissez le serveur que vous souhaitez. Une fois fait, cliquez sur le bouton "API". Vous pourrez alors configurer:

  • Le port qu'utilisera la module pour communiquer (ATTENTION, il ne doit pas être déjà utilisé !) ;
  • L'endpoint vers lequel notre site enverra les données (EXEMPLE: 123.12.123.12:8080/rwapi avec 8080 étant le port configuré au dessus, et 123.12.123.12 l'IP de votre machine.) ;
  • Un mot de passe unique pour vérifier que les données vous sont bien envoyées à vous.

Une fois tout ceci fait, enregistrez et passez à l'étape suivante.

Etape 2: Mise en place de l'API

Une fois l'étape de configuration faite, vous allez désormais devoir, dans le code de votre robot, ajouté un bout de code pour que l'API fonctione. Voici le code en question:

const { APICLient } = require('rw-api.js');
const RWClient = new APIClient(endpoint, port, password); // L'endpoint, le port, et le password doivent être les mêmes que ceux configurés sur le site. 
                                                          // Pour l'endpoint, mettez simplement ce qui se trouve après le / EXEMPLE: L'endpoint sur le site est 123.12.123.12:8080/rwapi, mettez simplement /rwapi.
RWClient.on('vote', async (new_votes, user) => {
    /* Vous mettez ici ce que vous voulez.
     * new_votes est le nombre de votes que le serveur à après le vote de l'utilisateur et user est un objet User basique de discord.js;
     * Exemple:
    */

    const channel = this.client.channels.cache.get('123456789');
    channel.send(`Merci à ${user.username}#${user.discriminator} qui vient de voter pour le serveur ! Nous sommes désormais à ${new_vote} votes.`)
})
RWClient.start();