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-plugin-votes

v1.2.3

Published

Mongoose.js plugin to add voting methods to models.

Downloads

2

Readme

mongoose-plugin-votes

Codeship Status for CentralPing/mongoose-plugin-votes Code Climate for CentralPing/mongoose-plugin-votes Dependency Status for CentralPing/mongoose-plugin-votes

A mongoose.js plugin that provides vote and unvote methods for model instances. The method names are configurable (e.g. like and unlike).

Note: document changes are not persisted until document is saved.

Installation

npm i --save mongoose-plugin-votes

API Reference

Example

var votesPlugin = require('mongoose-plugin-votes');
var schema = Schema({...});
schema.plugin(votesPlugin[, OPTIONS]);

mongoose-plugin-votes~options

Kind: inner property of mongoose-plugin-votes

| Param | Type | Default | Description | | --- | --- | --- | --- | | [options] | object | | | | options.path | string | "votes" | the path to create the propterty for storing votes. | | options.options | object | | property options to set (type will always be Array). (e.g. {select: false}) | | options.voteMethodName | string | "vote" | the method name to set a vote. | | options.unvoteMethodName | string | "unvote" | the method name to unset a vote. | | options.votes | object | | | | options.votes.ref | string | | the reference model to use (e.g. {votes: {ref: 'ModelRefName'}}) | | options.votes.options | object | | votes property options to set (type will always be String). (e.g. {votes: {options: {select: false}}}) |

mongoose-plugin-votes~vote(voter)

The vote method appends the passed in value to the votes path array

Kind: inner method of mongoose-plugin-votes

| Param | Type | Description | | --- | --- | --- | | voter | * | If using a reference pass in the ObjectId or the document |

mongoose-plugin-votes~unvote(voter)

The unvote method removes the passed in value from the votes path array

Kind: inner method of mongoose-plugin-votes

| Param | Type | Description | | --- | --- | --- | | voter | * | If using a reference pass in the ObjectId or the document |

Examples

With Strings

var votesPlugin = require('mongoose-plugin-votes');
var schema = Schema({foo: String});
schema.plugin(votesPlugin);

var Foo = mongoose.model('Foo', schema);
var foo = Foo(); // foo.votes --> []
foo.vote('candy'); // foo.votes --> ['candy']
foo.vote('candy'); // foo.votes --> ['candy']
foo.vote('ice cream'); // foo.votes --> ['candy', 'ice cream']
foo.unvote('candy'); // foo.votes --> ['ice cream']

With References

var votesPlugin = require('mongoose-plugin-votes');
var schema = Schema({foo: String});
schema.plugin(votesPlugin, {votes: {ref: 'UserModel'}});

var Foo = mongoose.model('Foo', schema);
var foo = Foo(); // foo.votes --> []
foo.vote(userA); // foo.votes --> [{_id: '507f191e810c19729de860ea'}]
foo.vote(userA.id); // foo.votes --> [{_id: '507f191e810c19729de860ea'}]
foo.vote(userB); // foo.votes --> [{_id: '507f191e810c19729de860ea'}, {_id: '507f191e810c19729de970fb'}]
foo.unvote(userA); // foo.votes --> [{_id: '507f191e810c19729de970fb'}]

License

Apache 2.0