async-func-decorators v1.0.3

async-func-decorators

Functors for transforming async functions as well as Promises

Supported throttle / debounce / sequential transformer's and delay async funcition

Installation

$ npm install async-func-decorators

Example

 
const asyncFunctors = require('async-func-decorators');

//throttled execution
const throttled = asyncFunctors.throttle(500, ()=>{...some async code })

//debounced execution
const debounced = asyncFunctors.debounce(500, ()=>{...some async code })

//serialized execution
const serialized = asyncFunctors.serial(()=>{...some async code })

API

throttle(wait, fn)

Creates a function that will call fn at most once every wait milliseconds.

Perform leading (as soon as possible) invocation.

fn will receive last context (this) and last arguments passed to a throttled wrapper before fn was invoked.

wrapped function returns Promise (i.e. it's an async function)

if some invocations delayed they are replaced with last one and all of them share same return value

debounce(wait, fn)

Creates a function that will call fn at most once every wait milliseconds.

Perform trailing (at time window's end) invocation.

fn will receive last context (this) and last arguments passed to a debounced wrapper before fn was invoked.

debounce(0, fn) return function that skip all invocation while previous one in progress

and call fn strictly after it if there is such invocation(s)

wrapped function returns Promise (i.e. it's an async function)

if some invocations delayed they are replaced with last one and all of them share same return value

serial(fn)

Creates a function that will call fn in serial,

i.e. all calls during function execution serialized and performed sequentially.

delay(wait)

return promise resolved after wait milliseconds.

License

MIT