Skip to content

Latest commit

 

History

History
212 lines (170 loc) · 3.65 KB

README.md

File metadata and controls

212 lines (170 loc) · 3.65 KB
Raw

mori-ext

Function bind syntax wrappers for mori

immutable data structures + LINQ in javascript

\__   __ \_______ \______   \___         \_______ \__  \__ \_______
|  |_|  ||       ||    _ |  |   |        |       ||  |_|  ||       |
|       ||   _   ||   | ||  |   |  ____  |    ___||       ||_     _|
|       ||  | |  ||   |_||_ |   | |____| |   |___ |       |  |   |  
|       ||  |_|  ||    __  ||   |        |    ___| |     |   |   |  
| ||_|| ||       ||   |  | ||   |        |   |___ |   _   |  |   |  
|_|   |_||_______||___|  |_||___|        |_______||__| |__|  |___|

thanks http://patorjk.com/software/taag

Quick example

import { vector } from 'mori';
import { assoc, equals } from 'mori-ext';

const v1 = vector('foo', 'bar', 'baz');
const v2 = v1::assoc(1, 'quux');
const v3 = vector('foo', 'quux', 'baz');
v2::equals(v3); // => true

How?

Using babeljs everyone can use this syntax.

Look at an example using gulp

Also, copy the .babelrc file, in order to enable the required language features in babeljs.

This effort is inspired by trine

Installation

npm install --save mori-ext

see https://www.npmjs.com/package/mori-ext

runtime dependencies

mori, babel-runtime,

Usage

Review the spec (covers the majority of the API)

API

mori-ext's API is mostly based on collections being the first argument to mori functions, i.e.

import mori from 'mori';
import { equals, isList } from 'mori-ext';

const coll = mori.vector(1, 2, 3);

mori.isList(coll);
// is equivalent to
coll::isList();

// and

mori.equals(coll1, coll2);
// is equivalent to
coll1::equals(coll2);

However, not all functions operate on a single collection, or even, on collections at all, so some consideration has been taken into account, e.g.

import { list, vector, seq } from 'mori';
import { mapcat, cons } from 'mori-ext';
// mapcat
((x, y) => list(x, x + y))
  ::mapcat(seq('abc'), seq('123'));
// => ('a' 'a1' 'b' 'b2' 'c' 'c3')

// cons (converts collection into seq)
1::cons(vector(2, 3))
// => (1 2 3)

Exported values

Fundamentals

equals
hash

Type Predicates

isList
isSeq
isVector
isMap
isSet
isCollection
isSequential
isAssociative
isCounted
isIndexed
isReduceable
isSeqable
isReversible

Collections

list
vector
hashMap
set
sortedSet
range
queue

Collection Operations

conj
into
assoc
dissoc
distinct
empty
get
getIn
hasKey
find
nth
last
assocIn
updateIn
count
isEmpty
peek
pop
zipmap
reverse

Vector Operations

subvec

Hash Map Operations

keys
vals
merge

Set Operations

disj
union
intersection
difference
isSubset
isSuperset

Sequences

first
rest
seq
cons
concat
flatten
intoArray
each
map
mapcat
filter
remove
reduce
reduceKV
take
takeWhile
drop
dropWhile
some
every
sort
sortBy
interpose
interleave
iterate
repeat
repeatedly
partition
partitionBy
groupBy

Helpers

primSeq
identity
constantly
inc
dec
sum
isEven
isOdd
comp
juxt
knit
pipeline
partial
curry
fnil
toClj
toJs