bukk 🐐

> Functional programming for Norwegians ⛷️


- Why?
- Goals and philosophies
- Examples
- Installation
- Usage
- Development
- "Bukk"?
- API

Why?

Not exactly. Well, not only for Norwegians. Inspired by Ramda, this an automatically curried, data-last, functional JavaScript library.

Goals and philosophies

- Declarative code

Much favored over "smart" code. As an example it is preferred to use existing higher-order functions like Array.prototype.every() instead of reimplementing similar logic using loops.

- Predictable behaviors

B.map(B.inc, 1) should return 2. Not [], [undefined] or [2]. Just 2.

- ES6 compliant

It is totally fine to do B.map(B.inc, new Set([1, 2, 3])). This will simply return Set {2, 3, 4}.

- Feature-rich

As seen above, B.map knows how to handle Sets. Similarly, other B functions that can operate on Arrays, typically knows how to operate on other data structures as well.

- No dependencies

- Great code coverage

Examples

``js
const incCollection = B.map(B.inc)

incCollection([1, 2, 3])
// => [2, 3, 4]

incCollection(new Set([1, 2, 3]))
// => Set {2, 3, 4}
`

`js
const isFoo = B.equals('foo')
const allIsFoo = B.all(isFoo)

allIsFoo({x: 'foo', y: 'foo', z: 'foo'})
// => true

allIsFoo(['foo', 'bar', 'baz'])
// => false
`

`js
const takeTwo = B.take(2)

takeTwo(new Map([[1, 'a'], [2, 'b'], [3, 'c']]))
// => Map { 1 => 'a', 2 => 'b' }

takeTwo('foobar')
// => 'fo'
`

`js
const double = B.multiply(2)
const addFive = B.add(5)
const incDoubleAndAddFive = B.compose(addFive, double, B.inc)

incDoubleAndAddFive(1)
// => 9
`

`js
const sqrtOfProduct = B.pipe(B.multiply, Math.sqrt)

sqrtOfProduct(3, 12)
// => 6
`

`js
const multiplyThree = (a, b, c) => a b c
const multiplyThreeCurried = B.curry(multiplyThree)

multiplyThreeCurried(2)
// => Function

multiplyThreeCurried(2)(3)
multiplyThreeCurried(2, 3)
// => Function

multiplyThreeCurried(2)(3)(4)
multiplyThreeCurried(2, 3)(4)
multiplyThreeCurried(2)(3, 4)
// => 24
`

Installation

Install using yarn:

`bash
yarn add bukk
`

Or npm:

`bash
npm install --save bukk
`

Usage

Import module:

`js
import * as B from 'bukk'
`

`js
import { compose, map, prop } from 'bukk'
`

Or add the B variable to the global scope:

`html

`

Development

Install dependencies:

`bash
yarn install
`

Build:

`bash
yarn run build
`

Will lint the source code, run tests and generate code coverage, and build a minified version of the library.

$3

Test once:

`bash
yarn run test
`

Test in watch mode:

`bash
yarn run dev
`

Reading coverage reports:

`bash
yarn run report
`

"Bukk"?

"Bukk" means "ram" in Norwegian :)

API

$3

Number --> Number --> Number

---

$3

(* --> Boolean) --> Array | Map | Object | Set | String --> Boolean

---

$3

a --> b --> a | b

---

$3

(* --> Boolean) --> Array | Map | Object | Set | String --> Boolean

---

$3

* --> Array | Map | Set | String --> Array | Map | Set | String

---

$3

(... --> b) --> (... --> d) --> b | d

---

$3

Function... --> Function

---

$3

Array | Map | Set | String --> Array | Map | Set | String --> Array | Map | Set | String

---

$3

Function --> Function

---

$3

Number --> Number

---

$3

Number --> Number --> Number

---

$3

(... --> b) --> (... --> d) --> b | d

---

$3

--> --> Boolean

---

$3

(* --> Boolean) --> Array | Map | Object | Set | String --> Array | Map | Object | Set | String

---

$3

( --> Boolean) --> Array | Map | Object | Set | String -->

---

$3

Array --> Array

---

$3

Number --> Number --> Boolean

---

$3

Number --> Number --> Boolean

---

$3

Array | Map | Set | String --> *

---

$3

Number --> Number

---

$3

Array | Map | Set | String --> Array | Map | Set | String

---

$3

* --> String

---

$3

Array | Map | Set | String --> *

---

$3

Number --> Number --> Boolean

---

$3

Number --> Number --> Boolean

---

$3

Function --> -->

---

$3

Number --> Number --> Number

---

$3

Object --> Object --> Object

---

$3

Number --> Number --> Number

---

$3

Number --> Number --> Number

---

$3

(* --> Boolean) --> Array | Map | Object | Set | String --> Boolean

---

$3

a --> b --> a | b

---

$3

Function... --> Function

---

$3

* --> Array | Map | Set | String --> Array | Map | Set | String

---

$3

String --> Object --> *

---

$3

Number --> Number --> Array

---

$3

(a --> b --> a) --> a --> Array | Map | Object | Set | String --> a

---

$3

(* --> Boolean) --> Array | Map | Object | Set | String --> Array | Map | Object | Set | String

---

$3

Array | Map | Set | String --> Array | Map | Set | String

---

$3

Number --> Number --> Array | Map | Set | String --> Array | Map | Set | String

---

$3

Function --> Array | Map | Set --> Array | Map | Set

---

$3

Number --> Number --> Number

---

$3

Array | Map | Set | String --> Array | Map | Set | String

---

$3

Number --> Array | Map | Set | String --> Array | Map | Set | String

---

$3

String --> String

---

$3

* --> String

---

$3

Array --> Array --> Array`