feat: add SegmentSplitter class

Author: Not-Jayden

README.md

@@ -169,6 +169,30 @@ console.log(secondWord);
 
 ---
 
+## SegmentSplitter Class
+
+Alternatively, the `SegmentSplitter` class allows you to create an instance that can be directly used with JavaScript's `String.prototype.split` method for basic segmentation.
+
+### Constructor
+
+```typescript
+new SegmentSplitter<T extends Granularity>(granularity: T, options?: SegmentationOptions<T>);
+```
+
+- **granularity**: Specifies the segmentation granularity level (`'grapheme'`, `'word'`, `'sentence'`, etc.).
+- **options**: Optional settings to customize the segmentation for the given granularity.
+
+## Example Usage
+
+```typescript
+const str = "Hello, world!";
+const wordSplitter = new SegmentSplitter("word", { isWordLike: true });
+const words = str.split(wordSplitter);
+console.log(words); // ["Hello", "world"]
+```
+
+---
+
 ## Individual Functions
 
 ### `getRawSegments`

package.json

@@ -1,6 +1,6 @@
 {
 	"name": "segment-string",
-	"version": "0.0.7",
+	"version": "0.0.8",
 	"description": "A lightweight wrapper around Intl.Segmenter for segment-aware string operations",
 	"repository": {
 		"type": "git",

src/index.ts

@@ -461,3 +461,25 @@ export class SegmentString {
 		return this.str;
 	}
 }
+
+/**
+ * A class that implements the `Symbol.split` method to use segmentation for splitting strings.
+ *
+ * Example usage:
+ * ```ts
+ * const str = "Hello, world!";
+ * const wordSplitter = new SegmentSplitter("word", { isWordLike: true });
+ * const words = str.split(wordSplitter);
+ * console.log(words); // ["Hello", "world"]
+ * ```
+ */
+export class SegmentSplitter<T extends Granularity> {
+	constructor(
+		private readonly granularity: T,
+		private readonly options: SegmentationOptions<T> = {},
+	) {}
+
+	[Symbol.split](str: string): string[] {
+		return [...getSegments(str, this.granularity, this.options)];
+	}
+}