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

forbin

v0.1.6

Published

ES6 Component for controllers with filter support.

Downloads

1

Readme

Forbin.js npm version license type npm downloads ECMAScript 6

ES6 Component for controllers with filter support.

import Controller from "forbin";

const logRequest = Symbol(),
	authenticate = Symbol(),
	logResponse = Symbol();

class ApplicationController extends Controller {
	filters(...options) {
		this.before(this[logRequest]);
		this.before([this.changePassword, this.changeUsername], this[authenticate]);
		this.after(this.changePassword, this[logResponse]);
		this.skip(this.changePassword, this[logRequest]);
	}

	[logRequest](request, response, next) {
		//log request before every action on the controller
		next();
	}

	[logResponse](request, response, next) {
		//log response after some action
		next();
	}

	[authenticate](request, response, next) {
		//authenticate user
		next();
	}

	changeUsername(request, response) {
		//here the request is logged and the client authenticated
		//do your action and send the response
	}

	changePassword(request, response) {
		//here the client is authenticated but the log skipped
		//do your action and send the response
		//after this action the response will be logged
	}

	getInfo(request, response) {
		//here the request is logged but is a public operation
		//do your action and send the response
	}
}

Quality and Compatibility

Build Status Coverage Status Code Climate Dependency Status Dev Dependency Status

Every single build and release is automatically tested on the following platforms:

node 0.12.x node 0.11.x node 0.10.x iojs 2.x.x iojs 1.x.x

If your platform is not listed above, you can test your local environment for compatibility by copying and pasting the following commands into your terminal:

npm install forbin
cd node_modules/forbin
gulp test-local

Installation

Copy and paste the following command into your terminal to install Forbin:

npm install forbin --save

Import / Require

// ES6
import Controller from "forbin";
// ES5
var Controller = require("forbin");
// Require.js
define(["require"] , function (require) {
    var Controller = require("forbin");
});

Getting Started

Using it

You should extend the base Controller provided within forbin in order to apply filters and take advantage of the provided functionality.

As the above example shows, you can define a specific filter to every action on the controller, to a specific one, or to an array of actions.

There are three filter functions available right now:

  • before
  • after
  • skip

All those functions share the same interface:

before(filterToApply); //this will apply a before filter to all actions
before(functionToApplyTheFilterTo, filterToApply); //this will apply a before filter to a specific action
before(arrayOfFunctionsToApplyTheFilterTo, filterToApply); //this will apply the filter to the provided array of actions

after(filterToApply); //this will apply an after filter to all actions
after(functionToApplyTheFilterTo, filterToApply); //this will apply an after filter to a specific action
after(arrayOfFunctionsToApplyTheFilterTo, filterToApply); //this will apply the filter to the provided array of actions

skip(filterToApply); //this will skip a filter on all actions
skip(functionToApplyTheFilterTo, filterToApply); //this will skip a filter on a specific action
skip(arrayOfFunctionsToApplyTheFilterTo, filterToApply); //this will skip the filter on the provided array of actions

How to Contribute

See something that could use improvement? Have a great feature idea? We listen!

You can submit your ideas through our issues system, or make the modifications yourself and submit them to us in the form of a GitHub pull request.

We always aim to be friendly and helpful.

Running Tests

It's easy to run the test suite locally, and highly recommended if you're using Forbin.js on a platform we aren't automatically testing for.

npm test