<commit_before># alef.js 

![alef.js logo](graphics/alef.js.png)

Immutable Data Structures JavaScript Library

---

## Table of Contents

* [Description](#descripton)
* [Install](#install)
* [API](#api)
* [Build](#build)
* [Test](#test)
* [Name](#name)

## Description

__alef.js__ is a javascript library which provides immutable data structures.

Interfaces are loosy modeled after [Scala](http://www.scala-lang.org).

This __**alpha**__ release and currently has only on type `List`.

## Install

```bash
$ npm install --save alef.js
```

## API

API documentation is automatically generated by `scripts/jsdoc.sh` and can be 
found [API Documentation](API.md).

> **NB** Generated documentation might not be up to date. If unsure check 
sources directly.

## Test

```bash
$ git clone https://github.com/mtavkhelidze/alef.js.git
$ cd alef.js
$ npm install
$ npm test
```

## Name

**_Aleph-null_** (or
_Aleph-naught_ or _aleph-zero_) is the
[cardinality](https://en.wikipedia.org/wiki/Cardinality) of the set of [natural
numbers](https://en.wikipedia.org/wiki/Natural_number).

Similaraly to functional programming (which this library is about)
__Aleph-null__ has something to do with __mathematics__ (set theory),
__immutability__, and __beer__:

> 99 bottles of beer on the wall, 99 bottles of beer, Take one down, Put it
> back up, 99 bottles of beer on the wall (repeat).

### Logo

The big semi-circle in the logo is Georgian [_asomtavruli_
(ასომთავრული)](https://en.wikipedia.org/wiki/Georgian_scripts) *A**, _aleph_
that is.<commit_msg>Fix typo<commit_after># alef.js 

![alef.js logo](graphics/alef.js.png)

Immutable Data Structures JavaScript Library

---

## Table of Contents

* [Description](#descripton)
* [Install](#install)
* [API](#api)
* [Build](#build)
* [Test](#test)
* [Name](#name)

## Description

__alef.js__ is a javascript library which provides immutable data structures.

Interfaces are loosy modeled after [Scala](http://www.scala-lang.org).

This __**alpha**__ release and currently has only on type `List`.

## Install

```bash
$ npm install --save alef.js
```

## API

API documentation is automatically generated by `scripts/jsdoc.sh` and can be 
found [API Documentation](API.md).

> **NB** Generated documentation might not be up to date. If unsure check 
sources directly.

## Test

```bash
$ git clone https://github.com/mtavkhelidze/alef.js.git
$ cd alef.js
$ npm install
$ npm test
```

## Name

**_Aleph-null_** (or
_Aleph-naught_ or _aleph-zero_) is the
[cardinality](https://en.wikipedia.org/wiki/Cardinality) of the set of [natural
numbers](https://en.wikipedia.org/wiki/Natural_number).

Similaraly to functional programming (which this library is about)
__Aleph-null__ has something to do with __mathematics__ (set theory),
__immutability__, and __beer__:

> 99 bottles of beer on the wall, 99 bottles of beer, Take one down, Put it
> back up, 99 bottles of beer on the wall (repeat).

### Logo

The big semi-circle in the logo is Georgian [_asomtavruli_
(ასომთავრული)](https://en.wikipedia.org/wiki/Georgian_scripts) *A*, _aleph_
that is.
{'fraction_non_alphanumeric': 0.13050518134715025, 'fraction_numerical': 0.0038860103626943004, 'mean_word_length': 4.596014492753623, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 9, 'https://': 8, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '4240771', 'n_tokens_mistral': 1102, 'n_tokens_neox': 1029, 'n_words': 334}