Skip to content
/ fnuc Public

a functional library for coffeescript (and javascript)

Notifications You must be signed in to change notification settings

algesten/fnuc

Repository files navigation

(fnuc) ->

Build Status Gitter

cause i want it my way.

fnuc is a library for functional programming in coffeescript (and javascript). The reason for providing the "standard" javascript methods as pure functions is to facilitate functional composition and higher order functions.

Installing with NPM

npm install -S fnuc

Inject into global

require('fnuc').expose(global);

Or use it library style with a prefix:

F = require('fnuc');  // all functions under F

Use destructuring assignment to pick things you want.

Coffeescript

{split, map} = require 'fnuc'

Javascript

let {split, map} = require('fnuc');

Installing with Bower

bower install -S fnuc

Compatibility

Tested on IE9+, Chrome 38+, Firefox 34+, Safari 7+.

About

Design philosophy:

  • fnuc tries to follow the principle of least astonishment. This shows in function argument order which is clearly spelled out in this stack overflow answer.

  • Less is more. fnuc provides the most used basics, not every conceivable utility function. Please suggest functions to add if anything important is missing.

  • Javascript is liberating. Functional programming purists may argue the virtues of immutability and typing whilst I would argue the opposite; the lack of rigour has made programming fun again. fnuc embraces all of javascript and will mutate where appropriate.

Argument order

We expect a function such as div to have the following two forms:

div(a, b)    # a divided by b
div(b)(a)    # right section (`div` b)

div is curried and div10 = div(10) can only have the meaning division by 10. Hence div10 20 should equal 2.

Other least astonished variants that are not in fnuc:

div(_, b)    # left section (a `div`)
a `div` b    # infix haskell style
a.div b      # infix coffeescript style

plift

Plifting is a strategy for using simple functions (perhaps even pure functions) when dealing with promises.

There is a separate page on plifting.

API

I add all always and any apply arity arityof at both call clone comp compose concat cond contains converge curry div drop each either eq eql evolve filter firstfn flip fold1 fold foldr1 foldr get gt gte has head iif index indexfn isdef isplain join keys keyval last lastfn lcase len lt lte map match max maybe merge min mixin mod mul not nth ofilter omap once or pall partial partialr pfail pick pipe plift replace reverse search set shallow slice sort split sub tail take tap trim type typeis ucase unapply uniq uniqfn values zip zipobj zipwith

License

The MIT License (MIT)

Copyright © 2015 Martin Algesten

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.

About

a functional library for coffeescript (and javascript)

Resources

Stars

Watchers

Forks

Packages

No packages published