scats 1.0.32 → 1.2.0

package/README.md

@@ -16,7 +16,7 @@ import {Collection, Nil} from "scats";
 
 const empty = Collection.empty; // empty collection
 const empty2 = Nil; // empty collection
-const example = new Collection([1, 2, 3]); // create instance from arrau
+const example = new Collection([1, 2, 3]); // create instance from array
 const example2 = Collection.fill(3)(idx => idx + 1); // Collection.of(1, 2, 3)
 const c = Collection.of(1, 2, 3);
 for (let el of c) {
@@ -218,7 +218,6 @@ map.size; // 1
 map.isEmpty; // false
 HashMap.empty.isEmpty; // true
 map.nonEmpty; // true
-map.nonEmpty; // true
 map.get('1'); // some(1)
 map.get('5'); // none
 map.getOrElse('1', () => 5); // 1
@@ -229,7 +228,7 @@ map.values; // Collection.of(1, 2)
 map.entries; // Collection.of(['1', 1], ['2', 2])
 map.appendedAll(HashMap.of(['3', 3])); // HashMap.of(['1', 1], ['2', 2], ['3', 3])
 map.set('2', 3); // HashMap.of(['1', 1], ['2', 3])
-map.remove('2'); // HashMap.of(['1', 1])
+map.removed('2'); // HashMap.of(['1', 1])
 map.updated('2', 4); // HashMap.of(['1', 1], ['2', 4])
 ```
 
@@ -339,3 +338,83 @@ await forComprehension.promise(
 ).yield(({num1, num2, num3}) => num1 + num2 + num3); // throws Error('Error in task')
 
 ```
+
+
+
+## ArrayBuffer
+Represents the mutable collection of items of some type backed by array.
+
+```typescript
+import {mutable} from "scats";
+import ArrayBuffer = mutable.ArrayBuffer;
+
+const empty = ArrayBuffer.empty; // []
+const example = new ArrayBuffer([1, 2, 3]); // create instance from array
+const example2 = ArrayBuffer.fill(3)(idx => idx + 1); // ArrayBuffer.of(1, 2, 3)
+const c = ArrayBuffer.of(1, 2, 3);
+for (let el of c) {
+    console.log(el); // 1, 2, 3
+}
+c.slice(2, 5); // ArrayBuffer.of(3)
+c.map(e => e + 1); // ArrayBuffer.of(2, 3, 4) (new instance)
+ArrayBuffer.of(1, 2).flatMap(x => ArrayBuffer.of(x, x + 1)); // ArrayBuffer.of(1, 2, 2, 3)
+ArrayBuffer.of(1, ArrayBuffer.of(2, 3), 4).flatten<number>(); // ArrayBuffer.of(1, 2, 3, 4)    
+ArrayBuffer.of(1, 2, 3).get(1); // 2    
+ArrayBuffer.of(1, 2, 3).toArray; // [1, 2, 3]    
+ArrayBuffer.of(1, 2, 3).reverse; // ArrayBuffer.of(3, 2, 1)    
+ArrayBuffer.of(2, 3, 1).sort((a, b) => a - b); // ArrayBuffer.of(1, 2, 3)    
+ArrayBuffer.of({x: 2}, {x: 1}, {x: 3}).sortBy(el => el.x); // ArrayBuffer.of(1, 2, 3)
+ArrayBuffer.of(1, 2).append(3); // ArrayBuffer.of(1, 2, 3) - same instance
+ArrayBuffer.of(1, 2).appended(3); // ArrayBuffer.of(1, 2, 3) - new instance
+ArrayBuffer.of(1, 2).appendAll(ArrayBuffer.of(3, 4)); // ArrayBuffer.of(1, 2, 3, 4) - same instance
+ArrayBuffer.of(1, 2).appendAll([3, 4]); // ArrayBuffer.of(1, 2, 3, 4) - same instance
+ArrayBuffer.of(1, 2).appendedAll(ArrayBuffer.of(3, 4)); // ArrayBuffer.of(1, 2, 3, 4) - new instance
+ArrayBuffer.of(1, 2).prepend(0); // ArrayBuffer.of(0, 1, 2) - same instance
+ArrayBuffer.of(1, 2).prepended(0); // ArrayBuffer.of(0, 1, 2) - new instance
+ArrayBuffer.of(1, 2).prepended(ArrayBuffer.of(-1, 0)); // ArrayBuffer.of(-1, 0, 1, 2) - same instance
+ArrayBuffer.of(1, 2).prependedAll(ArrayBuffer.of(-1, 0)); // ArrayBuffer.of(-1, 0, 1, 2) - new instance
+ArrayBuffer.of(1, 2).concat(ArrayBuffer.of(3, 4)); // ArrayBuffer.of(1, 2, 3, 4)
+ArrayBuffer.of(1, 2, 2).toSet; // HashSet.of(1, 2)
+ArrayBuffer.of(1, 2, 2).distinct; // ArrayBuffer.of(1, 2) - new instance
+ArrayBuffer.of({x: 2}, {x: 1}, {x: 2}).distinctBy(el => el.x); // ArrayBuffer.of({x: 2}, {x: 1}) - new instance
+ArrayBuffer.of({id: 1, name: 'Alice'}, {id: 2, name: 'Bob'}).toMap(el => [el.id, el.name]); // HashMap(1 -> 'Alice', 2 -> 'Bob')
+c.sum(identity); // 6. We have to provide identity to convert element to number
+c.take(2); // Collection.of(1, 2)
+c.drop(1); // Collection.of(2, 3);
+c.head; // 1
+```
+
+
+## mutable.HashMap
+```typescript
+import {mutable} from "scats";
+
+const map = new mutable.HashMap<string, number>()
+map.set('Alice', 11); // ('Alice' -> 11)
+map.set('Bob', 12); // ('Alice' -> 11, 'Bob' -> 12)
+map.clear(); // ()
+map.put('Steve', 14); // returns some(14), map: ('Steve' -> 14)
+map.update('Alice', 11); // ('Steve' -> 14, 'Alice' -> 11)
+map.remove('Alice'); // ('Steve' -> 14)
+map.addOne(['Bob', 12]); // ('Steve' -> 14, 'Bob' -> 12)
+map.subtractOne('Bob'); // ('Steve' -> 14)
+map.addAll([['Alice', 11], ['Bob', 12]]); // ('Steve' -> 14, 'Alice' -> 11, 'Bob' -> 12)
+map.mapValuesInPlace(([name, age]) => age + 1); // ('Steve' -> 15, 'Alice' -> 12, 'Bob' -> 13)
+map.filterInPlace(([name, age]) => age > 13); // ('Steve' -> 15)
+```
+
+
+## mutable.HashSet
+```typescript
+import {mutable} from "scats";
+
+const set = new mutable.HashSet<string, number>()
+set.add(1); // true. set = [1]
+set.add(1); // false. set = [1]
+set.clear(); // []]
+set.add(1); // true. set = [1]
+set.remove(2); false. set = [1]
+set.remove(1); true. set = []
+set.addAll([2, 3]); set = [1, 2, 3]
+set.filterInPlace(x => x > 2); // [3]
+```