wfun

0.12.1 • Public • Published

wfun

npm version Build Status Coveralls

Wrap your plain JS functions into different functions, based on common patterns for plugins and middlewares.

The concept is that you want to write the business logic one way, but reuse it in multiple environment.

Installation

Run the install command:

npm install --save wfun

About

It is common when you want to handle messages in a network environment, you will receive an object that contains request/input data and another object that contains response callback function (even if it is a property like res.send(...) or a msg.payload). But there are tons of code (really cool packages) not designed to receive its expected argument that way. We have to wrap them into functions and map the request object properties and/or a callback to arguments and then call the actual business logic.

Usage examples

Wrap 'endsWith' function from Lodash package

Incoming request object:

{
    payload: { string: 'someString', target: 'S', position: '5' }
    // ... pattern, additional toolkit related properties, etc.
}
const wfun = require('wfun')
 
const { endsWith } = require('lodash')
 
const wrappedFunction = wfun(endsWith, {
    argsPath: 'payload',
    map: [ 'string', 'target', 'position' ]
})
 
// wrappedFunction --> (msg, cb) => cb(null, _.endsWith(msg.payload.string, msg.payload.target, msg.payload.position))

Notes

Although this library can be used alone, it is one of the artifacts of a proof-of-concept project, which is focusing to seperate the business logic implementation from the infrastructure logic to keep it as independent/adaptive/pure as possible.

If you are interested please also check the repositories listed below which can be used together to achieve the greater goal:

  • pluginizer - A tool to create plugins or middlewares for different Javascript tools, frameworks, servers.
  • npac - A lightweight Ports and Adapters Container for applications running on Node.js platform.

Package Sidebar

Install

npm i wfun

Weekly Downloads

1

Version

0.12.1

License

MIT

Unpacked Size

26 kB

Total Files

9

Last publish

Collaborators

  • bersilius