iterable-linq-utility 0.0.14 → 0.0.16

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) [2022] [Federico Maria Ceruti]
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) [2022] [Federico Maria Ceruti]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1 +1,35 @@
-Work in Progress
+[![](https://data.jsdelivr.com/v1/package/npm/iterable-linq-utility/badge)](https://www.jsdelivr.com/package/npm/iterable-linq-utility)
+
+A [.NET Linq to Objects](https://learn.microsoft.com/it-it/dotnet/csharp/programming-guide/concepts/linq/linq-to-objects) porting with javacript naming conventions (e.g.: `Select` as been ranamed to `map`) and some new features (e.g.: [memoize](https://amebus.github.io/iterable-linq-utility/api-reference/transformations.md#memoize) and [materialize](https://amebus.github.io/iterable-linq-utility/api-reference/actions.md#materialize)).
+
+[Official documentation available here](https://amebus.github.io/iterable-linq-utility)
+
+## Main Idea
+
+As the previous description says, the idea is to create a kind-of-porting of [.NET Linq to Objects](https://learn.microsoft.com/it-it/dotnet/csharp/programming-guide/concepts/linq/linq-to-objects) with a naming convetions that is more javascript and functional programming oriented and not sql oriented [^1].  
+In other words the idea is:
+
+- to keep the [LINQ Deferred Exceution](https://learn.microsoft.com/en-us/dotnet/standard/linq/deferred-execution-lazy-evaluation#deferred-execution) and apply it to the [JavaScript Iterator Protocol](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols) with a more standard way of naming well known high order functions like `map`, `flatMap`, `reduce` used by javascript and some functional programming libraries (e.g.: [Ramdajs](https://github.com/functionalland/ramda), [SanctuaryJs](https://github.com/orgs/sanctuary-js/repositories?type=all), [FantasyLand](https://github.com/fantasyland) and [lodash](https://github.com/lodash/lodash)).
+- to keep the **Linq repeatable execution** which allows to traverse the same chain multiple times without having to recreate it from scratch every time, in this way is possible to store the chain in a variable and then trigger it to get the max and min without recreating it:
+
+  ```ts
+  const myChain = IterableLinq.from([1,2,3,4]).filter().map(); // chain creation
+  const max = myChain.max();
+  const min = myChain.min(); // using the same chain twice
+  ```
+
+Since in javascript you cannot rely on [extensions methods](https://learn.microsoft.com/en-us/dotnet/csharp/programming-guide/classes-and-structs/extension-methods) as in c# there is the need to create a wrapper over `Iterable` to achive the same [Deferred Exceution](https://learn.microsoft.com/en-us/dotnet/standard/linq/deferred-execution-lazy-evaluation#deferred-execution) concept.  
+
+```typescript
+IterableLinq
+    .fromRange(start, end)
+    .filter(myFilterFunction)
+    .map(myMapFunction)
+    .collectToArray()
+```
+
+as **Operations Chain** or **O~s~C**.  
+The **O~s~C** supports two types of operations:
+
+- [Actions](https://amebus.github.io/iterable-linq-utility/api-reference/actions.md)
+- [Transformations](https://amebus.github.io/iterable-linq-utility/api-reference/transformations.md)

package/dist/{genericCollections → collections}/linkedList.d.ts

@@ -3,7 +3,7 @@ export declare class LinkedList<T> implements Iterable<T> {
     private internalSize;
     private head;
     private tail;
-    [Symbol.iterator](): Iterator<T>;
+    [Symbol.iterator](): LinkedListIterator<T>;
     private internalAddFirst;
     addFirst(value: T): this;
     private internalAddLast;
@@ -12,8 +12,10 @@ export declare class LinkedList<T> implements Iterable<T> {
 }
 export declare class LinkedListIterator<T> implements Iterator<T> {
     private current;
-    constructor(current?: IListNode<T> | null);
+    constructor(current: IListNode<T> | null);
+    private innerNext;
     next(): IteratorResult<T, any>;
+    return(value?: any): IteratorResult<T, any>;
 }
 interface IListNode<T> {
     data: T;

package/dist/functions/forEach.d.ts

@@ -1,3 +1,3 @@
-import { Action, AsyncAction, Unit } from "./_types";
+import { Action, AsyncAction, Unit } from "../types";
 export declare function forEach<T>(iterable: Iterable<T>, action: Action<T>): Unit;
 export declare function forEachAsync<T>(iterable: Iterable<T>, action: AsyncAction<T>): Promise<Unit>;

package/dist/functions/index.d.ts

@@ -9,9 +9,9 @@ export { filter, flatMap, forEach, forEachAsync };
 import { map } from './map';
 import { materialize } from './materialize';
 import { max } from './max';
-import { memoize } from './memoize';
+import { memoize, getMemoizeDefaultOptions, IMemoizeOptions } from './memoize';
 import { min } from './min';
-export { map, materialize, max, memoize, min };
+export { map, materialize, max, memoize, getMemoizeDefaultOptions, type IMemoizeOptions, min };
 import { range } from './range';
 import { reduce } from './reduce';
 import { repeat } from './repeat';

package/dist/functions/map.d.ts

@@ -1,4 +1,4 @@
-import { Mapper } from "./_types";
+import { Mapper } from "../types";
 /**
  *
  * @operation `Transformation`

package/dist/functions/max.d.ts

@@ -1,4 +1,4 @@
-import type { Comparer } from "./_types";
+import type { Comparer } from "../types";
 /**
  *
  * @operation `Action`

package/dist/functions/memoize.d.ts

@@ -1,7 +1,11 @@
+export interface IMemoizeOptions {
+    allowPartialMemoization?: boolean;
+}
+export declare function getMemoizeDefaultOptions(): IMemoizeOptions;
 /**
  *
  * @operation `Transformation`
  * @param iterable
  * @returns
  */
-export declare function memoize<T>(iterable: Iterable<T>): Iterable<T>;
+export declare function memoize<T>(iterable: Iterable<T>, options?: IMemoizeOptions): Iterable<T>;

package/dist/functions/min.d.ts

@@ -1,4 +1,4 @@
-import type { Comparer } from "./_types";
+import type { Comparer } from "../types";
 /**
  *
  * @operation `Action`

package/dist/functions/reduce.d.ts

@@ -1,4 +1,4 @@
-import { Reducer } from "./_types";
+import { Reducer } from "../types";
 /**
  *
  * @operation `Action`

package/dist/functions/some.d.ts

@@ -1,4 +1,4 @@
-import { Predicate } from "./_types";
+import { Predicate } from "../types";
 /**
  *
  * @operation `Action`

package/dist/functions/tap.d.ts

@@ -1,4 +1,4 @@
-import { Tapper } from "./_types";
+import { Tapper } from "../types";
 /**
  *
  * @operation `Tap`

package/dist/functions/tapChain.d.ts

@@ -1,4 +1,4 @@
-import { Tapper } from "./_types";
+import { Tapper } from "../types";
 /**
  *
  * @operation `Tap`