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

ywemay-api-user

v1.1.8

Published

API user functions

Downloads

4

Readme

API User

Provides authentication/authorization functions for a Mongo DB based user.

Setup

#install the module:
npm i ywemay-api-user

NOTE: This module requires a Mongoose connection to operate.

The .env file should contain the following keys with appropriate values:

# a string used to encrypt the token:
JWT_KEY="replace this string with any random string for token encryption"
# how many tries to login are allowed until user is delayed (by IP)
LOGIN_MAX_TRIES=10
# how long time to wait (minutes) until log in is allowed again
LOGIN_DELAY=20

Usage example:

This is how user routes may be added to the application:

const express = require("express");
const db = require("./db");
const users = require("ywemay-api-user");

// initialize express application
const app = express();
app.use(express.json());

db.connect();

users.config(app);

module.exports = app;

Endpoints

POST /auth/login
GET /auth/logout

POST /avatar/upload
GET /img/avatar

GET /user/preferences
PUT /user/preferences
PUT /user/change-password

GET /users
GET /users/id/:uid
GET /ref
POST /users
PUT /users/id/:uid
PUT /users
DELETE /users/id:uid
DELETE /users