@nyaomaru/divider 1.0.21 → 1.1.0

package/README.md

@@ -90,6 +90,20 @@ const flatArray = divider(['hello', 'new world'], ' ', 2, { flatten: true });
 // ['he', 'llo', 'ne', 'w', 'wor', 'ld']
 ```
 
+### 📌 `dividerFirst()` Usage
+
+`dividerFirst()` returns only the first divided element from the result.
+
+```ts
+import { dividerFirst } from '@nyaomaru/divider';
+
+const firstElement = dividerFirst('hello world', ' ');
+// 'hello'
+
+const firstArrayElement = dividerFirst(['hello', 'world'], 2);
+// 'he'
+```
+
 ## 🎯 Options
 
 | Option    | Type      | Default | Description                                                               |
@@ -113,6 +127,7 @@ const result2 = divider(words, 2, { flatten: true });
 - Works with both `strings` and `arrays of strings`
 - Supports `multiple separators` (mixing indexes and characters).
 - Provides an `optional flattening` feature for array results.
+- **Get only the first divided element using `dividerFirst()`**
 
 ## 🛠 Contributing
 

package/dist/cjs/core/divider-first.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.dividerFirst = dividerFirst;
+const divider_1 = require("@/core/divider");
+function dividerFirst(input, ...args) {
+    var _a, _b;
+    const result = (0, divider_1.divider)(input, ...args);
+    if (Array.isArray(result[0])) {
+        return (_a = result[0][0]) !== null && _a !== void 0 ? _a : '';
+    }
+    return (_b = result[0]) !== null && _b !== void 0 ? _b : '';
+}

package/dist/cjs/index.js

@@ -1,5 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.divider = void 0;
+exports.dividerFirst = exports.divider = void 0;
 var divider_1 = require("@/core/divider");
 Object.defineProperty(exports, "divider", { enumerable: true, get: function () { return divider_1.divider; } });
+var divider_first_1 = require("@/core/divider-first");
+Object.defineProperty(exports, "dividerFirst", { enumerable: true, get: function () { return divider_first_1.dividerFirst; } });

package/dist/esm/core/divider-first.js

@@ -0,0 +1,9 @@
+import { divider } from '@/core/divider';
+export function dividerFirst(input, ...args) {
+    var _a, _b;
+    const result = divider(input, ...args);
+    if (Array.isArray(result[0])) {
+        return (_a = result[0][0]) !== null && _a !== void 0 ? _a : '';
+    }
+    return (_b = result[0]) !== null && _b !== void 0 ? _b : '';
+}

package/dist/esm/index.js

@@ -1 +1,2 @@
 export { divider } from '@/core/divider';
+export { dividerFirst } from '@/core/divider-first';

package/dist/types/core/divider-first.d.ts

@@ -0,0 +1,2 @@
+import type { DividerArgs } from '@/core/types';
+export declare function dividerFirst<T extends string | string[], F extends boolean = false>(input: T, ...args: DividerArgs<F>): string;

package/dist/types/index.d.ts

@@ -1,2 +1,3 @@
 export { divider } from '@/core/divider';
+export { dividerFirst } from '@/core/divider-first';
 export type { DividerResult } from '@/core/types';

package/package.json

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