@nyaomaru/divider 1.7.2 → 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

@@ -187,12 +187,16 @@ function dividerLast(input, ...args) {
 }
 
 // src/utils/chunk.ts
-function generateIndexes(text, size) {
-  const indexes = [];
-  for (let i = size; i < text.length; i += size) {
-    indexes.push(i);
+function generateIndexes(str, size, startOffset = 0) {
+  if (!isPositiveInteger(size)) {
+    console.warn("generateIndexes: size must be a positive integer");
+    return [];
   }
-  return indexes;
+  const result = [];
+  for (let i = startOffset + size; i < str.length; i += size) {
+    result.push(i);
+  }
+  return result;
 }
 
 // src/core/divider-loop.ts
@@ -201,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));
+  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

@@ -3,6 +3,10 @@ declare const dividerOptionKeys: readonly ["flatten", "trim", "excludeEmpty"];
 type DividerOptionKey = (typeof dividerOptionKeys)[number];
 type DividerResult<T extends string | string[]> = T extends string ? string[] : string[][];
 type DividerOptions = Partial<Record<DividerOptionKey, boolean>>;
+type DividerLoopOptions = DividerOptions & {
+    startOffset?: number;
+    maxChunks?: number;
+};
 type DividerSeparators = (number | string)[];
 type DividerArgs = DividerSeparators | [...DividerSeparators, DividerOptions];
 
@@ -12,8 +16,8 @@ declare function dividerFirst(input: string | string[], ...args: DividerSeparato
 
 declare function dividerLast(input: string | string[], ...args: DividerSeparators): string;
 
-declare function dividerLoop<T extends string | string[]>(input: T, size: number, options?: DividerOptions): DividerResult<T>;
+declare function dividerLoop<T extends string | string[]>(input: T, size: number, options?: DividerLoopOptions): DividerResult<T>;
 
 declare function dividerNumberString<T extends string | string[]>(input: T, options?: DividerOptions): DividerResult<T>;
 
-export { type DividerArgs, type DividerOptionKey, type DividerOptions, type DividerResult, type DividerSeparators, divider, dividerFirst, dividerLast, dividerLoop, dividerNumberString };
+export { type DividerArgs, type DividerLoopOptions, type DividerOptionKey, type DividerOptions, type DividerResult, type DividerSeparators, divider, dividerFirst, dividerLast, dividerLoop, dividerNumberString };

package/dist/index.d.ts

@@ -3,6 +3,10 @@ declare const dividerOptionKeys: readonly ["flatten", "trim", "excludeEmpty"];
 type DividerOptionKey = (typeof dividerOptionKeys)[number];
 type DividerResult<T extends string | string[]> = T extends string ? string[] : string[][];
 type DividerOptions = Partial<Record<DividerOptionKey, boolean>>;
+type DividerLoopOptions = DividerOptions & {
+    startOffset?: number;
+    maxChunks?: number;
+};
 type DividerSeparators = (number | string)[];
 type DividerArgs = DividerSeparators | [...DividerSeparators, DividerOptions];
 
@@ -12,8 +16,8 @@ declare function dividerFirst(input: string | string[], ...args: DividerSeparato
 
 declare function dividerLast(input: string | string[], ...args: DividerSeparators): string;
 
-declare function dividerLoop<T extends string | string[]>(input: T, size: number, options?: DividerOptions): DividerResult<T>;
+declare function dividerLoop<T extends string | string[]>(input: T, size: number, options?: DividerLoopOptions): DividerResult<T>;
 
 declare function dividerNumberString<T extends string | string[]>(input: T, options?: DividerOptions): DividerResult<T>;
 
-export { type DividerArgs, type DividerOptionKey, type DividerOptions, type DividerResult, type DividerSeparators, divider, dividerFirst, dividerLast, dividerLoop, dividerNumberString };
+export { type DividerArgs, type DividerLoopOptions, type DividerOptionKey, type DividerOptions, type DividerResult, type DividerSeparators, divider, dividerFirst, dividerLast, dividerLoop, dividerNumberString };

package/dist/index.js

@@ -157,12 +157,16 @@ function dividerLast(input, ...args) {
 }
 
 // src/utils/chunk.ts
-function generateIndexes(text, size) {
-  const indexes = [];
-  for (let i = size; i < text.length; i += size) {
-    indexes.push(i);
+function generateIndexes(str, size, startOffset = 0) {
+  if (!isPositiveInteger(size)) {
+    console.warn("generateIndexes: size must be a positive integer");
+    return [];
   }
-  return indexes;
+  const result = [];
+  for (let i = startOffset + size; i < str.length; i += size) {
+    result.push(i);
+  }
+  return result;
 }
 
 // src/core/divider-loop.ts
@@ -171,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));
+  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.2",
+  "version": "1.7.4",
   "description": "To divide string or string[] with a given separator",
   "main": "./dist/index.cjs",
   "module": "./dist/index.js",
@@ -35,19 +35,19 @@
   "author": "nyaomaru",
   "license": "MIT",
   "devDependencies": {
-    "@eslint/js": "^9.22.0",
+    "@eslint/js": "^9.26.0",
     "@types/jest": "^29.5.14",
-    "@types/node": "^22.13.4",
-    "eslint": "^9.22.0",
-    "eslint-config-prettier": "^10.0.1",
-    "eslint-plugin-prettier": "^5.2.3",
+    "@types/node": "^22.15.12",
+    "eslint": "^9.26.0",
+    "eslint-config-prettier": "^10.1.2",
+    "eslint-plugin-prettier": "^5.4.0",
     "jest": "^29.7.0",
-    "prettier": "^3.5.1",
-    "ts-jest": "^29.2.5",
+    "prettier": "^3.5.3",
+    "ts-jest": "^29.3.2",
     "ts-node": "^10.9.2",
     "tsup": "^8.4.0",
-    "tsx": "^4.19.3",
-    "typescript": "^5.7.3"
+    "tsx": "^4.19.4",
+    "typescript": "^5.8.3"
   },
   "engines": {
     "node": ">=18"