@nyaomaru/divider 1.7.3 → 1.7.4

package/README.md

@@ -130,6 +130,22 @@ const result = dividerLoop('abcdefghij', 3);
 // Supports flatten option for string[]
 const result2 = dividerLoop(['hello', 'world'], 2, { flatten: true });
 // ['he', 'll', 'ow', 'or', 'ld']
+
+// You can also control where to start dividing using `startOffset`
+const result3 = dividerLoop('abcdefghij', 3, { startOffset: 1 });
+// ['abcd', 'efg', 'hij']
+
+// Combine with flatten and trim
+const result4 = dividerLoop(['  hello ', 'world  '], 2, {
+  flatten: true,
+  trim: true,
+  startOffset: 1,
+});
+// ['h', 'el', 'lo', 'wor', 'ld']
+
+// Limit the number of chunks using maxChunks
+const result5 = dividerLoop('abcdefghij', 3, { maxChunks: 2 });
+// ['abc', 'defghij']
 ```
 
 ### 📌 `dividerNumberString()` Usage
@@ -150,10 +166,10 @@ const result3 = dividerNumberString(['abc123', '45z'], { flatten: true });
 // ['abc', '123', '45', 'z']
 ```
 
-## 🎯 Options
+## 🎯 General Options
 
 | Option         | Type      | Default | Description                                                               |
-| -------------- | ----------| ------- | ------------------------------------------------------------------------- |
+| -------------- | --------- | ------- | ------------------------------------------------------------------------- |
 | `flatten`      | `boolean` | `false` | If `true`, the resulting nested arrays are flattened into a single array. |
 | `trim`         | `boolean` | `false` | If `true`, trims whitespace from each divided segment.                    |
 | `excludeEmpty` | `boolean` | `false` | If `true`, removes empty strings or strings with only whitespace.         |
@@ -197,6 +213,13 @@ const result2 = divider(['  a  ', ' ', '  b'], ' ', {
 // ['a', 'b']
 ```
 
+## Special Options
+
+| Option        | Type     | Default | Description                                                                                             |
+| ------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------- |
+| `startOffset` | `number` | `0`     | Starting index offset when dividing into chunks (only for `dividerLoop`)                                |
+| `maxChunks`   | `number` | `∞`     | Maximum number of chunks allowed. Extra chunks are joined into the last chunk. (only for `dividerLoop`) |
+
 ## 💡 Features
 
 - 🧩 Flexible Division: Index-based and string-based separators

package/dist/index.cjs

@@ -205,7 +205,17 @@ function dividerLoop(input, size, options) {
     console.warn("dividerLoop: chunk size must be a positive number");
     return [];
   }
-  const applyChunking = (str) => divider(str, ...generateIndexes(str, size, options?.startOffset ?? 0));
+  const { startOffset = 0, maxChunks } = options ?? {};
+  const applyChunking = (str) => {
+    let chunks = divider(str, ...generateIndexes(str, size, startOffset));
+    const shouldTruncateChunks = isNumber(maxChunks) && maxChunks > 0 && chunks.length > maxChunks;
+    if (shouldTruncateChunks) {
+      const head = chunks.slice(0, maxChunks - 1);
+      const tail = chunks.slice(maxChunks - 1).join("");
+      chunks = [...head, tail];
+    }
+    return chunks;
+  };
   if (isString(input)) {
     const result2 = applyChunking(input);
     return applyDividerOptions(result2, options ?? {});

package/dist/index.d.cts

@@ -5,6 +5,7 @@ type DividerResult<T extends string | string[]> = T extends string ? string[] :
 type DividerOptions = Partial<Record<DividerOptionKey, boolean>>;
 type DividerLoopOptions = DividerOptions & {
     startOffset?: number;
+    maxChunks?: number;
 };
 type DividerSeparators = (number | string)[];
 type DividerArgs = DividerSeparators | [...DividerSeparators, DividerOptions];

package/dist/index.d.ts

@@ -5,6 +5,7 @@ type DividerResult<T extends string | string[]> = T extends string ? string[] :
 type DividerOptions = Partial<Record<DividerOptionKey, boolean>>;
 type DividerLoopOptions = DividerOptions & {
     startOffset?: number;
+    maxChunks?: number;
 };
 type DividerSeparators = (number | string)[];
 type DividerArgs = DividerSeparators | [...DividerSeparators, DividerOptions];

package/dist/index.js

@@ -175,7 +175,17 @@ function dividerLoop(input, size, options) {
     console.warn("dividerLoop: chunk size must be a positive number");
     return [];
   }
-  const applyChunking = (str) => divider(str, ...generateIndexes(str, size, options?.startOffset ?? 0));
+  const { startOffset = 0, maxChunks } = options ?? {};
+  const applyChunking = (str) => {
+    let chunks = divider(str, ...generateIndexes(str, size, startOffset));
+    const shouldTruncateChunks = isNumber(maxChunks) && maxChunks > 0 && chunks.length > maxChunks;
+    if (shouldTruncateChunks) {
+      const head = chunks.slice(0, maxChunks - 1);
+      const tail = chunks.slice(maxChunks - 1).join("");
+      chunks = [...head, tail];
+    }
+    return chunks;
+  };
   if (isString(input)) {
     const result2 = applyChunking(input);
     return applyDividerOptions(result2, options ?? {});

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@nyaomaru/divider",
   "type": "module",
-  "version": "1.7.3",
+  "version": "1.7.4",
   "description": "To divide string or string[] with a given separator",
   "main": "./dist/index.cjs",
   "module": "./dist/index.js",