berserk

A library of convenient function by Jituan Lin

This is Jituan Lin 's utils library, maybe is also helpful for you.

This project is power by Ramda.js

Note:.

• Almost function is curring for you.

• berserk depend on ramda,ensure you install ramda correctly.

How to use

1. install berserk
   npm install berserk

2. import or require the berserk, depend your environment.

   1. in node.js

   	const j =require('berserk')
       // berserk include a whole Ramda.js in it
   	j.log('great: ',j.always('hello world'))
       // will log:
       //  GREAT:
       //      hello world
   

   1. with webpack

       import j from 'berserk'
       //berserk also has it's own function
       j.midFlow(
   	    [
       	    ({a})=>({b:a+1}),
       	    ({b})=>({c:a+b}),
       	    (obj)=>j.log(obj)
           ]
        )({a:1})
       //log: { a:1, b:2 , c:3 }
   

     const {readdir} =require('fs')
     const readdirP=toPromise(readdir)
     readdir(Path)
       .then(
         files=>console.log(files),
         (err)=>console.log(err)
         )
   
   

How to build

npm run build

How to test

npm run test

Generate API doc

npm run doc

API doc

Functions

checkErr(res, rej) ⇒ function

A convenient function for handle error in callback function. Accept two function res(resolve) and rej(reject) , return a wrap function that accept a list arguments, the first argument as error, if error is null, the res function will call,else the rej function.

debug(title) ⇒ function

accept a title, return a function, the return function accept any data then log it with title(for better debug), then return the data back

flow(data, ...funList)

Same as ramda's pipe, but will accept a data and some function as it's arguments.Then call first function with data and past the result as arguments of next function, then call the second function as previous function result chain by chain...

isSuperSet(childSet, supperSet)

Judge a set is it another set's childSet

log(title, content)

Better log function, will accept title and content as it's arguments, then console.log it

Matcher(...matcherList)

Same as ramda's cond,but more readable

midFlow(mids) ⇒ function

the middleware must accept a object as 'context' and return a object to merge to context

Pair(first, second)

The factory function to construct a single pair

sameTo() ⇒ any

A function return a unit what pass to it

setEq(set1, set2) ⇒ boolean

Compare whether two set (es6: new Set(iterable)) is same as.

toPromise(fun) ⇒ function

Wrap the callback style function to Promise style function, the callback style function must restrict by convention:

1. the function must put the callback function where the last of arguments, such as (arg1,arg2,arg3,arg...,callback)
2. the callback function must call as callback(err,arg1，arg2,arg...)

checkErr(res, rej) ⇒ function

A convenient function for handle error in callback function. Accept two function res(resolve) and rej(reject) , return a wrap function that accept a list arguments, the first argument as error, if error is null, the res function will call,else the rej function.

Kind: global function
Returns: function - return a function that accept a list arguments, the first argument as error, if error is null, the res function will call,else the rej function

Param	Type	Description
res	function	the function which will call when no error throw
rej	function	the function which will call when error occur

debug(title) ⇒ function

accept a title, return a function, the return function accept any data then log it with title(for better debug), then return the data back

Kind: global function

Param	Type
title	any

Example

debug('the great')('hello world')
// will log 'THE GREAT: hello world',and return
// => 'hello world'

flow(data, ...funList)

Same as ramda's pipe, but will accept a data and some function as it's arguments.Then call first function with data and past the result as arguments of next function, then call the second function as previous function result chain by chain...

Kind: global function

Param	Type
data	any
...funList	function

Example

flow(
	1,
	R.inc,
	R.inc
)
//=> 3

isSuperSet(childSet, supperSet)

Judge a set is it another set's childSet

Kind: global function

Param	Type
childSet	Set
supperSet	Set

Example

isSupperSet(
		new Set([1, {a: 2}, 3]),
		new Set([1, {a: 2}, 3, 4])
)
// return false

log(title, content)

Better log function, will accept title and content as it's arguments, then console.log it

Kind: global function

Param	Type
title	any
content	any

Example

const j =require('berserk')
const fs =require('fs')
fs.readdir(
	'path',
	j.ifErr(j.log('success'),j.log(error occur))
)
// will print 'SUCCESS: ['file1','file2'...]',if not error thrown
// otherwise print 'ERROR OCCUR: error message'

Matcher(...matcherList)

Same as ramda's cond,but more readable

Kind: global function

Param	Type
...matcherList	array

Example

const j=require('berserk')
const Pattern=Pair
const matcher=Matcher(
		Pattern(R.is(Array),R.head),
		Pattern(R.T,R.always('no match'))
)
mather([1,2,3])
//=> 1

midFlow(mids) ⇒ function

the middleware must accept a object as 'context' and return a object to merge to context

Kind: global function
Returns: function - A function that accept a object as initial 'context' pass to first middleware

Param	Type	Description
mids	array	a array of middleware,

Example

// A function use midFlow for create a element(browser) by option
const elm = j.midFlow(
    [
       ({tag}) => ({el: document.createElement(tag)}),
       ({el, attr = {}}) => {
            R.forEachObjIndexed(
                 (value, name) => el[name] = value,
                 attr
             )
          },
        ({children = [], el}) => {
            j.midFlow(
                 [
                     ({doc}) => {
                         R.forEach(
                             (child) => doc.appendChild(child),
                             children
                         )
                       },
                      ({doc}) => {el.appendChild(doc)}
                  ]
            )({doc: new DocumentFragment})
         },
        ({evtLir = [], el}) => {
              R.forEach(
                 ({handler, type, opt = {}}) => el.addEventListener(type, handler, opt),
                  evtLir
               )
         },
       ({el}) => el
   ]
)

Pair(first, second)

The factory function to construct a single pair

Kind: global function

Param	Type
first	any
second	any

Example

const pair=Pair('name','jituanlin')
//=> ['name','jituanlin']

sameTo() ⇒ any

A function return a unit what pass to it

Kind: global function
Params: any
Example

sameTo('hello world!')
// return 'hello world!'

setEq(set1, set2) ⇒ boolean

Compare whether two set (es6: new Set(iterable)) is same as.

Kind: global function

Param	Type
set1	Set
set2	Set

Example

j.setEq(
   new Set([1, 2, 3]),
   new Set([3, 2, 1])
) // return true

j.setEq(
   new Set([1, 2]),
     new Set([1, 2, 3])
)// return false

toPromise(fun) ⇒ function

Wrap the callback style function to Promise style function, the callback style function must restrict by convention:

1. the function must put the callback function where the last of arguments, such as (arg1,arg2,arg3,arg...,callback)
2. the callback function must call as callback(err,arg1，arg2,arg...)

Kind: global function
Returns: function - Return the new function that will return a Promise, while the origin function throw a error, the Promise will be Promise.reject(error), while the origin function work fine, the Promise will be Promise.resolve(args: array), the args is which callback function accept

Param	Type	Description
fun	function	The callback style function to transform

Example

const {readdir} =require('fs')
   const readdirP=toPromise(readdir)
   readdir(Path)
     .then(
       files=>console.log(files),
       (err)=>console.log(err)
       )