nodash

Build Status Dependencies Dependencies

nodash offers you a rich set of library functions, comparable to the likes of underscore or lodash. The functions are actually derived from the Haskell Prelude and emphasize a functional programming style.

A special trait of this library is that it discards some JavaScript concepts (like prototypes or optional arguments) to allow some (in the authors opinion) more useful ones (such as currying).

Every function from this library can be thought of as curried, i.e. you can partially apply any function and get a function in return (on the other hand this means there are no optional arguments). It also supports lists which can be evaluated lazily and infinite streams.

A tiny list of features:

Browse through the apidoc, gallery, benchmark, or tests for examples.

For a list of which prelude functions are covered see the apidoc appendix.

Nodash is available via npm.

Example

Nodash.install(global || window); // node or browser

var reverse = foldl(flip(cons), []);

console.log(reverse([1,2,3])); // → [3,2,1]

Usage

in node

npm install --save nodash
var Nodash = require('nodash');

in the browser

<script src="nodash.js"></script>
<script>
    // Nodash is available in `window.Nodash`
    document.write(Nodash.foldl(Nodash.flip(cons), []));
</script>

in legacy browsers

Just pull in es5-shim first:

<script src="https://cdnjs.cloudflare.com/ajax/libs/es5-shim/4.1.13/es5-shim.js"></script>
<script src="nodash.js"></script>

install(mountpoint)

It is possible to attach the Nodash functions directly to the global object (in fact, any object), optionally with a prefix or postfix:

Nodash.install(global);           → foldl(flip(cons), []);
Nodash.install([ '$', global ]);  → $foldl($flip($cons), []);
Nodash.install([ global, '_' ]);  → foldl_(flip_(cons_), []);
Nodash.install([ 'f_', global ]); → f_foldl(f_flip(f_cons), []);

Both a prefix and a postfix works too:

Nodash.install([ '__', global, '__' ]); → __foldl__(__flip__(__cons__), []);

License

Copyright (c) 2015 Julian Alexander Fleischer

Permission is hereby granted, free of charge, to any
person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the
Software without restriction, including without
limitation the rights to use, copy, modify, merge,
publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software
is furnished to do so, subject to the following
conditions:

The above copyright notice and this permission notice
shall be included in all copies or substantial portions
of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
IN THE SOFTWARE.
Fork me on GitHub