https://github.com/meteorhacks/picker

Server Side Router for Meteor
https://github.com/meteorhacks/picker

Last synced: about 2 months ago
JSON representation

Server Side Router for Meteor

• Host: GitHub
• URL: https://github.com/meteorhacks/picker
• Owner: meteorhacks
• License: mit
• Created: 2014-12-15T08:22:43.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2018-03-21T06:44:57.000Z (over 6 years ago)
• Last Synced: 2024-01-06T22:46:37.753Z (6 months ago)
• Language: JavaScript
• Size: 12.7 KB
• Stars: 181
• Watchers: 8
• Forks: 30
• Open Issues: 30
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Lists

• awesome-meteor - meteorhacks:picker - Server Side Router for Meteor. (Routers)

README

        
[![](https://api.travis-ci.org/meteorhacks/picker.svg)](https://travis-ci.org/meteorhacks/picker)

# Picker - Server Side Router for Meteor

Picker is an easy to use server side router for Meteor. This router respect others. So, you can use Iron Router and other routers and middlewares along side with this.

## Install

~~~

meteor add meteorhacks:picker

~~~

## Getting Started

~~~js

Picker.route('/post/:_id', function(params, req, res, next) {

  var post = Posts.findOne(params._id);

  res.end(post.content);

});

~~~

 * You can use Meteor APIs inside this callback (runs inside a Fiber)

 * Route definitions are very similar to Iron Router and Express

 * `req` is an instance of NodeJS [http.IncomingMessage](http://nodejs.org/api/http.html#http_class_http_incomingmessage)

 * `res` is an instance of NodeJS [http.ServerResponse](http://nodejs.org/api/http.html#http_class_http_serverresponse)

 * `next` is optional and call it, if you don't need to handle the current request

## Filtering and Sub Routes

This is an unique functionality of this router. See following example:

Let's say we need to handle only `POST` requests. This is how you can do it with `Picker`.

~~~js

var postRoutes = Picker.filter(function(req, res) {

  // you can write any logic you want.

  // but this callback does not run inside a fiber

  // at the end, you must return either true or false

  return req.method == "POST";

});

postRoutes.route('/post/:id', function(params, req, res, next) {

  // ...

});

~~~

You can create any amount of sub routes with this `filter` API. Same time, you can create nested sub routes as well.

## Middlewares

You can use existing `connect` and `express` middlewares without any issues.

~~~js

// You can use the meteorhacks:npm package to load in the body-parser package

// via NPM.

var bodyParser = Meteor.npmRequire( 'body-parser');

// Add two middleware calls. The first attempting to parse the request body as

// JSON data and the second as URL encoded data.

Picker.middleware( bodyParser.json() );

Picker.middleware( bodyParser.urlencoded( { extended: false } ) );

~~~

You can use middlewares on sub routes as well.