feat: add chunk to fx (marpple#291)

* feat: add `chunk` to `fx`

* chore: codeowners

Author: ppeeou

.github/CODEOWNERS

@@ -2,4 +2,4 @@
     @ppeeou @shine1594 @hg-pyun
 
 # source
-/src/ @ppeeou @shine1594
+/src/ @ppeeou

src/Lazy/fx.ts

@@ -15,6 +15,7 @@ import type { DeepFlat } from "../types/DeepFlat";
 import type IterableInfer from "../types/IterableInfer";
 import type Key from "../types/Key";
 import type { SyncReducer } from "../types/Reducer";
+import chunk from "./chunk";
 import concurrent from "./concurrent";
 import drop from "./drop";
 import filter from "./filter";
@@ -189,6 +190,16 @@ class FxAsyncIterable<A> {
     return new FxAsyncIterable(f(this.asyncIterable));
   }
 
+  /**
+   * Returns AsyncIterable of elements split into groups the length of size.
+   * If AsyncIterableIterator can't be split evenly, the final chunk will be the remaining elements.
+   *
+   * see {@link https://fxts.dev/docs/chunk | chunk}
+   */
+  chunk(size: number) {
+    return new FxAsyncIterable(chunk(size, this.asyncIterable));
+  }
+
   /**
    * Concurrent is used to balance the load of multiple asynchronous requests.
    * The first argument receives a number that controls the number of loads, and the second argument is an AsyncIterable.
@@ -473,6 +484,16 @@ export class FxIterable<A> {
     return new FxIterable(f(this.iterable));
   }
 
+  /**
+   * Returns Iterable of elements split into groups the length of size.
+   * If iterableIterator can't be split evenly, the final chunk will be the remaining elements.
+   *
+   * see {@link https://fxts.dev/docs/chunk | chunk}
+   */
+  chunk(size: number) {
+    return new FxIterable(chunk(size, this.iterable));
+  }
+
   /**
    * Returns AsyncIterable, `toAsync` used when you want to handle Promise values inside Iterable.
    *

test/Lazy/chunk.spec.ts

@@ -3,6 +3,7 @@ import {
   concurrent,
   delay,
   filter,
+  fx,
   map,
   pipe,
   range,
@@ -46,6 +47,25 @@ describe("chunk", function () {
       const res = pipe(range(1, 12), chunk(3), toArray);
       expect(res).toEqual(expected);
     });
+
+    it.each([
+      [
+        [1, 2, 3, 4],
+        [
+          [1, 2],
+          [3, 4],
+        ],
+      ],
+      [
+        [1, 2, 3, 4, 5],
+        [[1, 2], [3, 4], [5]],
+      ],
+    ])(
+      "should be able to be used as a chaining method in the `fx`",
+      function (data: number[], result: number[][]) {
+        expect(fx(data).chunk(2).toArray()).toEqual(result);
+      },
+    );
   });
 
   describe("async", function () {
@@ -132,6 +152,25 @@ describe("chunk", function () {
       expect(res).toEqual(expected);
     });
 
+    it.each([
+      [
+        [1, 2, 3, 4],
+        [
+          [1, 2],
+          [3, 4],
+        ],
+      ],
+      [
+        [1, 2, 3, 4, 5],
+        [[1, 2], [3, 4], [5]],
+      ],
+    ])(
+      "should be able to be used as a chaining method in the `fx`",
+      async function (data: number[], result: number[][]) {
+        expect(await fx(data).toAsync().chunk(2).toArray()).toEqual(result);
+      },
+    );
+
     it("should be passed concurrent object when job works concurrently", async function () {
       const mock = generatorMock();
       const iter = chunk(3, mock);

type-check/Lazy/chunk.test.ts

@@ -1,23 +1,33 @@
-import { chunk, pipe, toAsync } from "../../src";
+import { chunk, fx, pipe, toAsync } from "../../src";
+import type Cast from "../../src/types/Cast";
 import * as Test from "../../src/types/Test";
 
 const { checks, check } = Test;
 
 const res1 = chunk(1, []);
 const res2 = chunk(1, [1, 2, 3]);
 const res3 = chunk(1, toAsync([1, 2, 3]));
-
 const res4 = pipe([1, 2, 3, 4], chunk(1));
 const res5 = pipe(Promise.resolve([1, 2, 3, 4]), chunk(1));
 const res6 = pipe(toAsync([1, 2, 3, 4]), chunk(1));
+const res7 = fx([1, 2, 3, 4]).chunk(2);
+const res8 = fx([1, 2, 3, 4]).toAsync().chunk(2);
 
 checks([
   check<typeof res1, IterableIterator<never[]>, Test.Pass>(),
-
   check<typeof res2, IterableIterator<number[]>, Test.Pass>(),
   check<typeof res3, AsyncIterableIterator<number[]>, Test.Pass>(),
-
   check<typeof res4, IterableIterator<number[]>, Test.Pass>(),
   check<typeof res5, Promise<IterableIterator<number[]>>, Test.Pass>(),
   check<typeof res6, AsyncIterableIterator<number[]>, Test.Pass>(),
+  check<
+    typeof res7,
+    Cast<IterableIterator<number[]>, typeof res7>,
+    Test.Pass
+  >(),
+  check<
+    typeof res8,
+    Cast<AsyncIterableIterator<number[]>, typeof res8>,
+    Test.Pass
+  >(),
 ]);