@nyaomaru/divider 1.9.0 → 1.9.2

package/README.md

@@ -265,3 +265,9 @@ We welcome contributions!
 Please read our [CONTRIBUTING.md](./CONTRIBUTING.md) guide before submitting a PR.
 
 Thank you for your contribution. 😺
+
+## 📚 Additional Documents
+
+- [DEVELOPER.md](./DEVELOPER.md) — Development setup and contributor guide
+- [CODE_OF_CONDUCT.md](./CODE_OF_CONDUCT.md) — Community standards and conduct
+- [CHANGELOG.md](./CHANGELOG.md) — Version history and notable changes

package/dist/index.cjs

@@ -316,7 +316,7 @@ function dividerLast(input, ...args) {
   return getLastElement(result, "");
 }
 
-// src/utils/chunk.ts
+// src/utils/generate-indexes.ts
 function generateIndexes(str, size, startOffset = 0) {
   if (!isPositiveInteger(size)) {
     console.warn("generateIndexes: size must be a positive integer");
@@ -329,7 +329,7 @@ function generateIndexes(str, size, startOffset = 0) {
   return result;
 }
 
-// src/core/divider-loop.ts
+// src/utils/chunk.ts
 var MIN_ALLOWED_CHUNKS = 0;
 function shouldTruncateChunks(chunks, maxChunks) {
   return isNumber(maxChunks) && maxChunks > MIN_ALLOWED_CHUNKS && maxChunks < chunks.length;
@@ -340,6 +340,8 @@ function truncateChunksToMax(chunks, maxChunks) {
   const tail = chunks.slice(headCount).join("");
   return [...head, tail];
 }
+
+// src/core/divider-loop.ts
 function createChunksFromString(str, size, startOffset, maxChunks) {
   const indexes = generateIndexes(str, size, startOffset);
   const chunks = divider(str, ...indexes);

package/dist/index.d.cts

@@ -16,7 +16,7 @@ declare const DividerExcludeModes: {
 
 type DividerExcludeMode = (typeof DividerExcludeModes)[keyof typeof DividerExcludeModes];
 type StringInput = string;
-type StringArrayInput = string[];
+type StringArrayInput = readonly string[];
 type DividerInput = StringInput | StringArrayInput;
 type DividerStringResult = string[];
 type DividerArrayResult = string[][];
@@ -65,7 +65,7 @@ declare function divider<T extends DividerInput>(input: T, ...args: DividerArgs)
  * dividerFirst("hello-world", "-") // returns "hello"
  * dividerFirst("abc123def", 3) // returns "abc"
  */
-declare function dividerFirst(input: string | string[], ...args: DividerSeparators): string;
+declare function dividerFirst(input: DividerInput, ...args: DividerSeparators): string;
 
 /**
  * Extracts the last segment after dividing the input using specified separators.
@@ -77,7 +77,7 @@ declare function dividerFirst(input: string | string[], ...args: DividerSeparato
  * dividerLast("hello-world", "-") // returns "world"
  * dividerLast("abc123def", 3) // returns "def"
  */
-declare function dividerLast(input: string | string[], ...args: DividerSeparators): string;
+declare function dividerLast(input: DividerInput, ...args: DividerSeparators): string;
 
 /**
  * Divides input into chunks of specified size with optional configuration.
@@ -98,7 +98,7 @@ declare function dividerLast(input: string | string[], ...args: DividerSeparator
  * dividerLoop("abcdef", 2) // returns ["ab", "cd", "ef"]
  * dividerLoop("abcdef", 2, { maxChunks: 2 }) // returns ["ab", "cdef"]
  */
-declare function dividerLoop<T extends string | string[]>(input: T, size: number, options?: DividerLoopOptions): DividerResult<T>;
+declare function dividerLoop<T extends DividerInput>(input: T, size: number, options?: DividerLoopOptions): DividerResult<T>;
 
 /**
  * Divides a string or array of strings by separating numbers from non-numbers.
@@ -113,7 +113,7 @@ declare function dividerLoop<T extends string | string[]>(input: T, size: number
  * dividerNumberString("abc123def") // returns ["abc", "123", "def"]
  * dividerNumberString("test42") // returns ["test", "42"]
  */
-declare function dividerNumberString<T extends string | string[]>(input: T, options?: DividerOptions): DividerResult<T>;
+declare function dividerNumberString<T extends DividerInput>(input: T, options?: DividerOptions): DividerResult<T>;
 
 type EmailDividerOptions = Pick<DividerOptions, 'trim'> & {
     /** Split top-level domain from the rest of the email address. */

package/dist/index.d.ts

@@ -16,7 +16,7 @@ declare const DividerExcludeModes: {
 
 type DividerExcludeMode = (typeof DividerExcludeModes)[keyof typeof DividerExcludeModes];
 type StringInput = string;
-type StringArrayInput = string[];
+type StringArrayInput = readonly string[];
 type DividerInput = StringInput | StringArrayInput;
 type DividerStringResult = string[];
 type DividerArrayResult = string[][];
@@ -65,7 +65,7 @@ declare function divider<T extends DividerInput>(input: T, ...args: DividerArgs)
  * dividerFirst("hello-world", "-") // returns "hello"
  * dividerFirst("abc123def", 3) // returns "abc"
  */
-declare function dividerFirst(input: string | string[], ...args: DividerSeparators): string;
+declare function dividerFirst(input: DividerInput, ...args: DividerSeparators): string;
 
 /**
  * Extracts the last segment after dividing the input using specified separators.
@@ -77,7 +77,7 @@ declare function dividerFirst(input: string | string[], ...args: DividerSeparato
  * dividerLast("hello-world", "-") // returns "world"
  * dividerLast("abc123def", 3) // returns "def"
  */
-declare function dividerLast(input: string | string[], ...args: DividerSeparators): string;
+declare function dividerLast(input: DividerInput, ...args: DividerSeparators): string;
 
 /**
  * Divides input into chunks of specified size with optional configuration.
@@ -98,7 +98,7 @@ declare function dividerLast(input: string | string[], ...args: DividerSeparator
  * dividerLoop("abcdef", 2) // returns ["ab", "cd", "ef"]
  * dividerLoop("abcdef", 2, { maxChunks: 2 }) // returns ["ab", "cdef"]
  */
-declare function dividerLoop<T extends string | string[]>(input: T, size: number, options?: DividerLoopOptions): DividerResult<T>;
+declare function dividerLoop<T extends DividerInput>(input: T, size: number, options?: DividerLoopOptions): DividerResult<T>;
 
 /**
  * Divides a string or array of strings by separating numbers from non-numbers.
@@ -113,7 +113,7 @@ declare function dividerLoop<T extends string | string[]>(input: T, size: number
  * dividerNumberString("abc123def") // returns ["abc", "123", "def"]
  * dividerNumberString("test42") // returns ["test", "42"]
  */
-declare function dividerNumberString<T extends string | string[]>(input: T, options?: DividerOptions): DividerResult<T>;
+declare function dividerNumberString<T extends DividerInput>(input: T, options?: DividerOptions): DividerResult<T>;
 
 type EmailDividerOptions = Pick<DividerOptions, 'trim'> & {
     /** Split top-level domain from the rest of the email address. */

package/dist/index.js

@@ -283,7 +283,7 @@ function dividerLast(input, ...args) {
   return getLastElement(result, "");
 }
 
-// src/utils/chunk.ts
+// src/utils/generate-indexes.ts
 function generateIndexes(str, size, startOffset = 0) {
   if (!isPositiveInteger(size)) {
     console.warn("generateIndexes: size must be a positive integer");
@@ -296,7 +296,7 @@ function generateIndexes(str, size, startOffset = 0) {
   return result;
 }
 
-// src/core/divider-loop.ts
+// src/utils/chunk.ts
 var MIN_ALLOWED_CHUNKS = 0;
 function shouldTruncateChunks(chunks, maxChunks) {
   return isNumber(maxChunks) && maxChunks > MIN_ALLOWED_CHUNKS && maxChunks < chunks.length;
@@ -307,6 +307,8 @@ function truncateChunksToMax(chunks, maxChunks) {
   const tail = chunks.slice(headCount).join("");
   return [...head, tail];
 }
+
+// src/core/divider-loop.ts
 function createChunksFromString(str, size, startOffset, maxChunks) {
   const indexes = generateIndexes(str, size, startOffset);
   const chunks = divider(str, ...indexes);

package/package.json

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