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

fh-wfm-mongo-store

v1.0.1

Published

Direct mongo storage

Downloads

19

Readme

raincatcher-mongo-store

Mongodb storage implementation

Run tests

Ensure Mongo is running on your machine, type the following command

npm test

Models

Mongoose models can be found in models directory. To add a new model use the same naming convention for desired dataset. ie. workorders model for workorders dataset / collection. Then require the directory and access the model using the name applied.

Note: Each schema require autogenerated timestamp that are used by other modules like raincatcher-sync to determine if object was changed. When creating new schema please make sure to add {timestamps: true} as schema option.

API

connect

To connect to mongo


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

var customSchemas = {
    //The key is the same as the datasetId (e.g. workorders)
    workorders: function(mongooseConnection) {
        var customWorkorderSchema = new Schema({
            ...
            name: {type: String}
            ...
        },  {timestamps: true});
        
        mongooseConnection.model('CustomWorkorderModel', customWorkorderSchema);
    }
    ... 
    //Any other custom schemas
    ...
};

Connector.connect('mongodb://mongoUriGoseHere:27017/db', {}, customSchemas)
  .then(function() {
    // connected successfully
  }, function(error) {
    // An error occurred when connecting
  });

getDAL

Get the Data access layer object for a collection/dataset.


var datasetId = "workorders";

Connector.getDAL(datasetId).
  then(function(_dal) {
    // do stuff with dataset dal
  }, function(error) {
    // handle error
  });

listen

The Data Access Layer object for a collection has a listen function that ensures that the CRUDL topics for the data set are subscribed.


/**
* This function has access to the mongoose Model associated with the data set
* through the "model" property
*
* @returns {Promise}
*/
function customListFunction() {
  return this.model.list();
}


var datasetId = "workorders";

Connector.getDAL(datasetId).
  then(function(_dal) {
    
    //This function will subscribe to the CRUDL topics for "workorders"
    //The "list" topic will execute the "customListFunction"
    //Note: This function will only overrdie the "list" topic for a single data set.
    _dal.listen(":data", mediator, {
        list: customListFunction
    });
    
  }, function(error) {
    // handle error
  });

The following functions are overridable:

  • create
  • update
  • list
  • remove
  • read

disconnect

Connector.disconnect()
  .then(function() {
    // disconnected
  }, function(error) {
    // something went wrong
  });