taky-redis-throttle

!taky-redis-throttle

install

using npm

``
npm i taky-redis-throttle --save
`

example

` coffeescript
Throttle = require 'taky-redis-throttle'

one instance accesses multiple throttling rules

###
{ counters: { minute: 166, hour: 166, day: 166, week: 166, month: 166 },
is_maxed: false,
percent: '33.20',
_meta:
{ elapsed: 5,
rule:
{ _id: '3twttjbc7q1',
key: 'login_attempts',
max: 500,
time: 'minute',
ctime: 1443154353 } } }
{ counters: { minute: 335, hour: 335, day: 335, week: 335, month: 335 },
is_maxed: false,
percent: '67.00',
_meta:
{ elapsed: 2,
rule:
{ _id: '3twttjbc7q1',
key: 'login_attempts',
max: 500,
time: 'minute',
ctime: 1443154353 } } }
{ counters: { minute: 505, hour: 505, day: 505, week: 505, month: 505 },
is_maxed: true,
percent: '100.00',
_meta:
{ elapsed: 2,
rule:
{ _id: '3twttjbc7q1',
key: 'login_attempts',
max: 500,
time: 'minute',
ctime: 1443154353 } } }
{ counters: { minute: 675, hour: 675, day: 675, week: 675, month: 675 },
is_maxed: true,
percent: '100.00',
_meta:
{ elapsed: 2,
rule:
{ _id: '3twttjbc7q1',
key: 'login_attempts',
max: 500,
time: 'minute',
ctime: 1443154353 } } }
###
`

constructor(options={})

` coffeescript
options =
redis: my_redis # an instance of ioredis, default creates one on 0.0:6379
prefix: 'limitations' # defaults to "throttle"
cache: yes
cache_time: '30 minutes'
`

.create(rule_opts={})

` coffeescript
rule_opts =
key: 'login_attempts'
time: 'minute' # ['minute','hour','day','week','month']
max: 500
`

.incr(key,amount=1,cb)

` coffeescript
update_obj =
time: 'minute' # ['minute','hour','day','week','month']
max: 1000
`

.remove(key,cb)

` javascript
{ counters: { minute: 675, hour: 675, day: 675, week: 675, month: 675 },
is_maxed: false,
percent: '6.75',
_meta:
{ elapsed: 1,
rule:
{ _id: '0twtfpc304z',
key: 'login_attempts',
max: 10000,
time: 'hour',
ctime: 1443153516,
utime: '1443153521' } } }
``