[]: {{{1

File        : README.md
Maintainer  : Felix C. Stegerman <flx@obfusk.net>
Date        : 2013-08-16

Copyright   : Copyright (C) 2013  Felix C. Stegerman
Version     : v0.0.2-SNAPSHOT

[]: }}}1

Description

[]: {{{1

obfusk.coffee - functional programming library for js/coffee

...

[]: }}}1

Examples

[]: {{{1

See http://obfusk.github.io/obfusk.coffee for the annotated source with examples.

[]: {{{2

O = require 'obfusk'

O.match O.Just(42),
  Nothing: -> console.log 'Nothing to see here ...'
  Just: (x) -> console.log "The answer is: #{x.value}"
# => (console) The answer is 42

neg = O.multi((x) -> 'default')
  .method ((x) -> typeof x == 'number'),
          ((x) -> -x)
  .method ((x) -> typeof x == 'boolean'),
          ((x) -> !x)
neg 42      # => -42
neg false   # => true
neg 'foo'   # => 'default'

[]: }}}2

[]: }}}1

Install

[]: {{{1

$ git clone https://github.com/obfusk/obfusk.coffee.git
$ cd obfusk.coffee
$ npm [-g] install

[]: }}}1

Specs & Docs

[]: {{{1

$ rake spec
$ rake docs

[]: }}}1

TODO

[]: {{{1

• build!
• examples!
• npm!
• more specs/docs?
• ...

[]: }}}1

License

[]: {{{1

GPLv2 [1] or EPLv1 [2].

[]: }}}1

References

[]: {{{1

[1] GNU General Public License, version 2 --- http://www.opensource.org/licenses/GPL-2.0

[2] Eclipse Public License, version 1 --- http://www.opensource.org/licenses/EPL-1.0

[]: }}}1

[]: ! ( vim: set tw=70 sw=2 sts=2 et fdm=marker : )