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

mongoose-token

v1.0.3

Published

Adds a password field that gets hashed when updated

Downloads

262

Readme

mongoose-token

io.js compatibility NPM version

Dependency Status Dev Dependency Status

Code Climate Build Status Coverage Status

A mongoose plugin to generate a token that has an expiration. Especially useful when generating an expiring token used for password resets.

Usage

'use strict';

var mongoose = require('mongoose');
var Schema   = mongoose.Schema;

// Obviously, you'd want more robust way of handling user authentication.
// Still need password hashing, and all that fun stuff.
var UserSchema = new Schema({
  email: String,
  password: String
});

UserSchema.plugin(require('mongoose-token'));

UserSchema.static('requestPasswordReset', function (email) {
  this.findOne({email: email}).exec().then(function (user) {
    if (!user) { return false; }
    return user.setToken();
  });
});

UserSchema.static('resetPassword', function (token, email, newPassword) {
  this.getByToken(token, {email: email}).then(function (user) {
    if (!user) { return false; }
    user.password = newPassword;
    return user.resetToken();
  });
});

So the things that this plugin adds:

document.setToken([cb]) - Sets the token and token expiration. You may pass in a callback (which accepts an error and the newly saved model) and it returns a promise.

document.resetToken([cb]) - Resets the token and token expiration. You may pass in a callback (which accepts an error and the newly saved model) and it returns a promise.

Model.getByToken(token[, query][, cb]) - Gets a document by the given token (and additional search parameters) if the token hasn't expired. The query and callback parameters are optional. You may pass in the callback as the second parameter if you don't have a query parameter. Also returns a promise.

Examples of the above methods in use are in the above example.

You may also set multiple tokens with multiple resets. Just call the .plugin method again and pass in different options for the property and method names. See options below.

To pass in options:

UserSchema.plugin(require('mongoose-token'), {
  tokenPath   : 'token',
  expiresPath : 'tokenExpires',
  setMethod   : 'setToken',
  getByMethod : 'getByToken',
  resetMethod : 'resetToken',
  tokenLength : 20,
  expire      : 1 * 60 * 60 * 1000 // 1 hour
});

Options

  • tokenPath (String) - The path to the token property. Default: 'token'
  • expiresPath (String) - The path to the token expiration property. Default: 'tokenExpires'
  • setMethod (String) - The name of the method that sets the token. Default: 'setToken'
  • getByMethod (String) - The name of the method that gets the model by the given token. Default: 'getByToken'
  • resetMethod (String) - The name of the method that resets the token and token expiration. Default: 'resetToken'
  • tokenLength (Number) - The length of the token string. Default: 20
  • expire (Number) - The number of milliseconds the token is valid for. Default: 1 * 60 * 60 * 1000 or 1 hour