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

@drama_llama/rift

v2.1.0

Published

Server and Mysql database connector.

Downloads

5

Readme

Rift

Running the Server

  node ./lib/RiftServer.js

by default this runs on port 8082, to make the server run on another port, specify the port number in the terminal as an argument:

  node ./lib/RiftServer.js 9000

this will run the server on port 9000.

Getting data from the database

The first thing we need to do is build a database request; this will allow the server to connect to whichever host, database and table you need.

  var dbRequest = {
    host: "localhost", //optional, default 'localhost'
    username: "your_db_username", //required
    password: "your_db_password", //required
    db: "the_db_you_are_connecting_to", //required
    table: "the_table_in_the_db", //required
    op: "GET" //or "SET", "DELETE", "SEARCH", //optional, default "GET"
    fields: ['name', 'surname', 'a_field', 'some_other_field'], //the fields you want to get (if this is [], it will get all the fields)
    conditions: {}, //optional
    options: {group_by: 'a_field', order_by: {'name': 'asc', 'a_field': 'desc'}, limit: 100} //optional 
  }

Connecting to the Server from the Client

To connect to the server and get the data we want, we need to create a new Request Object and pass in the dbRequest:

  const url = "http://localhost:8082"; //url to where the server is running, not where the database is stored.
  var request = new Request(url, {
    method: "POST",
    headers: {
        "Content-Type": "application/json"
        },
    mode: "cors", // specify this to enable data to be sent across different ports
    body: JSON.stringify(dbRequest) //send this as a string rather than an object
  }) ;
  

Now we simply do a fetch() - Note the fetch method returns a Promise that resolves to the Response. By chaining another Promise we can resolve to the Response parsed as JSON:

  fetch(request) //send request to the server, which connects to the db and runs a query and sends back a response
  .then((response) => response.json()) //once we have the response, parse it as json
  .then((result) => { // result is now the result of the database query
    //do something with 'result'
  }) ;