often
Async recursive timers
npm install often --save
var often = require
API
often(fn=undefined)
- Get an
often
instance withfn
as recursion function - All methods are chainable
.wait(ms=0)
Set interval to wait between recursions
.start(ms=0)
Start recursing after optional ms delay
.stop()
Immediately stop recursing
.done()
Immediately stop recursing and void instance
.use(fn=undefined)
Replace the recursion function
.clear()
internal
Clear active timer
.clean()
internal
Nullify properties
.init(fn=undefined)
internal
Initialize instance
Properties
._function
:fn
|null._recur
: boolean|null._timer
: integer|null._trial
: integer|null._wait
:ms
|null
Examples
Poll condition
var often = start
Limit attempts
var often = start1000
Decay task
var often = start
Heartbeat
var often = var energy = var emitter = var heartbeat = start emitter
Develop
git clone https://github.com/ryanve/often.gitcd oftennpm installnpm test
License
MIT