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

meteor-wapi-collection

v0.1.1

Published

Easy CUD (no R) collections for meteor-wapi

Downloads

3

Readme

Build Status Coverage Status Dependency Status devDependency Status

meteor-wapi-collection

Easy CUD (no R) collections for meteor-wapi

Install

npm i --save meteor-wapi-collection

Example

var express     = require("express");
var MongoClient = require("mongodb").MongoClient;
var MW          = require("meteor-wapi");
var Collection  = require("meteor-wapi-collection");

var mongoUrl = process.env.MONGO_URL || "mongodb://localhost:3001/meteor";

MongoClient.connect(mongoUrl, function (err, db) {
    var mw = new MW(db);
    var Books = new Collection(mw, "books");
    /*
    *   We now have three remote methods defined:
    *     - `/books/insert`
    *     - `/books/update`
    *     - `/books/remove`
    */
    var app = express()
        .use("/call", mw.getRouter())
        .listen(process.env.PORT || 4000);
});

API

new Collection(mw, name)

Creates a new Collection instance and attaches three remote methods to the supplied MW instance. The three methods are:

  • /collectionName/insert
  • /collectionName/update
  • /collectionName/remove
Arguments
  • mw MW instance required: the MW instance we wish to use with the collection.

  • name String required: the name of the collection.

Returns

A Collection instance.

.addValidationRules(rulesMap)

Registers validation rules for the insert, update and remove methods.

Validation rules can either:

  • throw or return a value (which is ignored)
  • return a promise which either gets fulfilled (with a value which is ignored) or rejected

If the rule returns a value (even undefined) or an eventually fulfilled promise, the value (fulfillment-value) is ignored and the operation continues (after subsequent rules are run).

If a rule throws, or returns a promise which gets rejected, the operation is aborted (subsequent rules won't run). If the error thrown (or passed as rejection value of the promise) is an instance of a MW.Error, then it'll get sent back to the client. Otherwise, a generic "500 Internal server error" error will be sent.

Validation rules have access to the same context of their associated method.

Arguments
  • rulesMap string-function dictionary required: a dictionary of validation functions, where the keys can either be insert, update or remove

TODO: consider giving the possibility to extend the context in which the validation rules run (as meteor-wapi does for methods).

Returns

The Collection instance to allow for method chaining.

Attached remote methods

/collectionName/insert (newDocument)

Inserts a document.

Arguments

  • newDocument Object required: the document to insert.

Returns

  • 200 OK if successful, 4** or 5** otherwise.

/collectionName/update (documentId, patches)

Updates a document.

Arguments

  • documentId String required: the _id of the document to update.

  • patches Array of JSON-Patches required: the array of JSON patches to apply to the document. JSON-Patches must conform to the rfc 6902 standard.

Returns

  • 200 OK if successful, 4** or 5** otherwise.

/collectionName/remove (documentId)

Removes a document.

Arguments

  • documentId String required: the _id of the document to remove.

Returns

  • 200 OK if successful, 4** or 5** otherwise.