From 3bbe5895c00824e6ef8d22df7a1e646ca2a88bd9 Mon Sep 17 00:00:00 2001 From: Dustin Diaz Date: Sun, 23 Mar 2014 15:17:59 -0700 Subject: [PATCH] `limiter` --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 722ec86..1dc3a63 100644 --- a/README.md +++ b/README.md @@ -10,9 +10,9 @@ var express = require('express') var app = express() var client = require('redis').createClient() -var limitter = require('express-limiter')(app, client) +var limiter = require('express-limiter')(app, client) -limitter({ +limiter({ path: '/api/action', method: 'get', lookup: ['connection.remoteAddress'], @@ -37,13 +37,13 @@ limiter(options) - `lookup`: `String|Array.` value lookup on the request object. Can be a single value or array. See [examples](#examples) for common usages - `total`: `Number` allowed number of requests before getting rate limited - `expire`: `Number` amount of time in `ms` before the rate-limited is reset - - `whitelist`: `function(req)` optional param allowing the ability to whitelist. return `boolean`, `true` to whitelist, `false` to passthru to limitter. + - `whitelist`: `function(req)` optional param allowing the ability to whitelist. return `boolean`, `true` to whitelist, `false` to passthru to limiter. ### Examples ``` js // limit by IP address -limitter({ +limiter({ lookup: 'connection.remoteAddress' })