stringzy 3.0.0 → 4.0.0

package/README.md

@@ -1,13 +1,12 @@
 <div align="center">
-  
-  
-  ![Stringzy banner](./assets/stringzy-banner2.jpg)
 
 
+  ![Stringzy banner](./assets/stringzy-banner2.jpg)
+
 ![NPM Version](https://img.shields.io/npm/v/stringzy)
+![Typescript](https://img.shields.io/badge/TypeScript-3178C6?style=flat&logo=typescript&logoColor=white)
 ![Downloads](https://img.shields.io/npm/dt/stringzy)
 ![License](https://img.shields.io/npm/l/stringzy)
-![Bundle Size](https://img.shields.io/bundlephobia/min/stringzy)
 [![Open Source Love svg1](https://badges.frapsoft.com/os/v1/open-source.svg?v=103)](https://github.com/ellerbrock/open-source-badges/)
 [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
 
@@ -15,15 +14,10 @@
 
 [Checkout our Contributors!](#contri)
 
-
 [Join the Community!](#community)
 
-
-
-
 </div>
 
-
 ## ✨ Features
 
 - 💪 **Powerful** - Transform, validate, analyze, and format strings with minimal code
@@ -66,7 +60,8 @@ const count = stringzy.analyze.wordCount('Hello world'); // 2
 
 ## 📋 Table of Contents
 
-###  Transformations
+### Transformations
+
 - [truncateText](#truncatetext) - Truncates text to a specified maximum length
 - [toSlug](#toslug) - Converts a string to a URL-friendly slug
 - [capitalizeWords](#capitalizewords) - Capitalizes the first letter of each word
@@ -76,31 +71,43 @@ const count = stringzy.analyze.wordCount('Hello world'); // 2
 - [initials](#initials) - Extracts initials from a text string
 - [camelCase](#camelcase) - Converts the given string to Camel Case
 - [pascalCase](#pascalcase) - Converts the given string to Pascal Case
-- [snakeCase](#snakecase) - Converts the given string to Snake Case   
+- [snakeCase](#snakecase) - Converts the given string to Snake Case
 - [kebabCase](#kebabcase) - Converts the given string to Kebab Case
 - [titleCase](#titlecase) - Converts the given string to Title Case
 - [constantCase](#constantcase) - Converts the given string to Constant Case
 - [escapeHTML](#escapehtml) - Escapes HTML special characters to prevent XSS attacks
 - [maskSegment](#masksegment) - Masks a segment of a string by replacing characters between two indices with a specified character
 - [deburr](#deburr) – Removes accents and diacritical marks from a string
+- [splitChunks](#splitchunks) - Breaks a string down into chunks of specified length.
+- [numberToText](#numbertotext) - Converts a number to its text representation in specified language
 
+### Validations
 
-###  Validations
 - [isURL](#isurl) - Checks if a string is a valid URL
 - [isEmail](#isemail) - Checks if a string is a valid email address
 - [isDate](#isdate) - Checks if a string is a valid date
 - [isEmpty](#isempty) - Checks if a string is empty or contains only whitespace
 - [isSlug](#isslug) - Checks if a string is a valid slug
+- [isTypeOf](#istypeof) - Checks if a file or URL has a valid extension for a given type
 - [isIPv4](#isipv4) - Checks if a string is a valid IPv4 address
 - [isHexColor](#ishexcolor) - Checks if the input string is a valid hex color
+- [isPalindrome](#ispalindrome) - Checks if the input string is a palindrome (ignores case, spaces, and punctuation)
+- [isCoordinates](#iscoordinates) - Checks if given latitude and longitude are valid coordinates
+
+### Analysis
 
-###  Analysis
 - [wordCount](#wordcount) - Counts the number of words in a string
 - [readingDuration](#readingduration) - Calculates the reading duration of a given string
 - [characterCount](#charactercount) - Counts the number of characters in a string
 - [characterFrequency](#characterfrequency) - Analyzes character frequency in a string
 - [stringSimilarity](#stringsimilarity) - Calculates the percentage similarity between two strings
-###  Formatting
+- [complexity](#complexity) - Analyzes string complexity including score, uniqueness, and length
+- [patternCount](#patterncount) - calculates the number of times a specific pattern occurs in a given text
+- [vowelConsonantCount](#vowelconsonantcount) - Counts the number of vowels and consonants in a given string 
+
+
+### Formatting
+
 - [capitalize](#capitalize) - Capitalizes the first letter of each word
 - [formatNumber](#formatnumber) - Formats a number string with thousand separators
 - [formatPhone](#formatphone) - Formats a phone number string to standard format
@@ -128,11 +135,11 @@ truncateText('Short', 10);
 // Returns: 'Short' (no truncation needed)
 ```
 
-| Parameter | Type | Default | Description |
-|-----------|------|---------|-------------|
-| text | string | required | The input string to truncate |
+| Parameter | Type   | Default  | Description                                            |
+| --------- | ------ | -------- | ------------------------------------------------------ |
+| text      | string | required | The input string to truncate                           |
 | maxLength | number | required | Maximum length of the output string (excluding suffix) |
-| suffix | string | '...' | String to append if truncation occurs |
+| suffix    | string | '...'    | String to append if truncation occurs                  |
 
 #### <a id="toslug"></a>`toSlug(text)`
 
@@ -151,9 +158,9 @@ toSlug('Special $#@! characters');
 // Returns: 'special-characters'
 ```
 
-| Parameter | Type | Default | Description |
-|-----------|------|---------|-------------|
-| text | string | required | The input string to convert to a slug |
+| Parameter | Type   | Default  | Description                           |
+| --------- | ------ | -------- | ------------------------------------- |
+| text      | string | required | The input string to convert to a slug |
 
 #### <a id="capitalizewords"></a>`capitalizeWords(text)`
 
@@ -172,9 +179,9 @@ capitalizeWords('already Capitalized');
 // Returns: 'Already Capitalized'
 ```
 
-| Parameter | Type | Default | Description |
-|-----------|------|---------|-------------|
-| text | string | required | The input string to capitalize |
+| Parameter | Type   | Default  | Description                    |
+| --------- | ------ | -------- | ------------------------------ |
+| text      | string | required | The input string to capitalize |
 
 #### <a id="removespecialchars"></a>`removeSpecialChars(text, replacement = '')`
 
@@ -193,10 +200,10 @@ removeSpecialChars('Phone: (123) 456-7890', '-');
 // Returns: 'Phone-123-456-7890'
 ```
 
-| Parameter | Type | Default | Description |
-|-----------|------|---------|-------------|
-| text | string | required | The input string to process |
-| replacement | string | '' | String to replace special characters with |
+| Parameter   | Type   | Default  | Description                               |
+| ----------- | ------ | -------- | ----------------------------------------- |
+| text        | string | required | The input string to process               |
+| replacement | string | ''       | String to replace special characters with |
 
 #### <a id="removewords"></a>`removeWords(text, wordsToRemove)`
 
@@ -209,20 +216,20 @@ removeWords('Hello world this is a test', ['this', 'is']);
 // Returns: 'Hello world a test'
 
 removeWords('Remove The Quick BROWN fox', ['the', 'brown']);
-// Returns: 'Remove Quick fox' 
+// Returns: 'Remove Quick fox'
 
 removeWords('JavaScript is awesome and JavaScript rocks', ['JavaScript']);
 // Returns: 'is awesome and rocks'
 ```
 
-| Parameter | Type | Default | Description |
-|-----------|------|---------|-------------|
-| text | string | required | The input string to process |
+| Parameter     | Type     | Default  | Description                              |
+| ------------- | -------- | -------- | ---------------------------------------- |
+| text          | string   | required | The input string to process              |
 | wordsToRemove | string[] | required | Array of words to remove from the string |
 
 #### <a id="removeduplicates"></a>`removeDuplicates(text)`
 
-Removes duplicate case-sensitive words from a given text. 
+Removes duplicate case-sensitive words from a given text.
 
 ```javascript
 import { removeDuplicates } from 'stringzy';
@@ -231,15 +238,15 @@ removeDuplicates('Hello world this is a is a test');
 // Returns: 'Hello world this is a test'
 
 removeDuplicates('Remove me me me me or Me');
-// Returns: 'Remove me or Me' 
+// Returns: 'Remove me or Me'
 
 removeDuplicates('JavaScript is not bad and not awesome');
 // Returns: 'JavaScript is not bad and awesome'
 ```
 
-| Parameter | Type | Default | Description |
-|-----------|------|---------|-------------|
-| text | string | required | The input string to process |
+| Parameter | Type   | Default  | Description                 |
+| --------- | ------ | -------- | --------------------------- |
+| text      | string | required | The input string to process |
 
 #### <a id="initials"></a>`initials(text, limit)`
 
@@ -264,10 +271,10 @@ initials('  Multiple   Spaces   Between  ');
 // Returns: 'MSB'
 ```
 
-| Parameter | Type | Default | Description |
-|-----------|------|---------|-------------|
-| text | string | required | The input string to extract initials from |
-| limit | number | undefined | Maximum number of initials to return (optional) |
+| Parameter | Type   | Default   | Description                                     |
+| --------- | ------ | --------- | ----------------------------------------------- |
+| text      | string | required  | The input string to extract initials from       |
+| limit     | number | undefined | Maximum number of initials to return (optional) |
 
 #### <a id="camelcase"></a>`camelCase(text)`
 
@@ -277,43 +284,41 @@ Converts the given string to Camel Case.
 import { camelCase } from 'stringzy';
 
 camelCase('hello world'); // 'helloWorld'
-camelCase('this is a test'); // 'thisIsATest' 
-``` 
-| Parameter | Type | Default | Description |
-|-----------|------|---------|-------------|
-| text | string | required | The input string to convert to Camel Case |
+camelCase('this is a test'); // 'thisIsATest'
+```
 
+| Parameter | Type   | Default  | Description                               |
+| --------- | ------ | -------- | ----------------------------------------- |
+| text      | string | required | The input string to convert to Camel Case |
 
 #### <a id="pascalcase"></a>`pascalCase(text)`
+
 Converts the given string to Pascal Case.
 
 ```javascript
 import { pascalCase } from 'stringzy';
 
-
 pascalCase('hello world'); // 'HelloWorld'
 pascalCase('this is a test'); // 'ThisIsATest'
 ```
-| Parameter | Type | Default | Description |
-|-----------|------|---------|-------------|
-| text | string | required | The input string to convert to Pascal Case |
+
+| Parameter | Type   | Default  | Description                                |
+| --------- | ------ | -------- | ------------------------------------------ |
+| text      | string | required | The input string to convert to Pascal Case |
 
 #### <a id="snakecase"></a>`snakeCase(text)`
 
 Converts the given string to Snake Case.
 
-```javascript 
+```javascript
 import { snakeCase } from 'stringzy';
 snakeCase('hello world'); // 'hello_world'
 snakeCase('this is a test'); // 'this_is_a_test'
 ```
 
-| Parameter | Type | Default | Description |
-|-----------|------|---------|-------------|
-| text | string | required | The input string to convert to Snake Case |
-
-
-
+| Parameter | Type   | Default  | Description                               |
+| --------- | ------ | -------- | ----------------------------------------- |
+| text      | string | required | The input string to convert to Snake Case |
 
 #### <a id="kebabcase"></a>`kebabCase(text)`
 
@@ -322,15 +327,13 @@ Converts the given string to Kebab Case.
 ```javascript
 import { kebabCase } from 'stringzy';
 
-
 kebabCase('hello world'); // 'hello-world'
 kebabCase('this is a test'); // 'this-is-a-test'
-``` 
-| Parameter | Type | Default | Description |
-|-----------|------|---------|-------------|
-| text | string | required | The input string to convert to Kebab Case |
-
+```
 
+| Parameter | Type   | Default  | Description                               |
+| --------- | ------ | -------- | ----------------------------------------- |
+| text      | string | required | The input string to convert to Kebab Case |
 
 #### <a id="titlecase"></a>`titleCase(text)`
 
@@ -339,28 +342,28 @@ Converts the given string to Title Case.
 ```javascript
 import { titleCase } from 'stringzy';
 
-
 titleCase('hello world'); // 'Hello World'
 titleCase('this is a test'); // 'This Is A Test'
 ```
-| Parameter | Type | Default | Description |
-|-----------|------|---------|-------------|
-| text | string | required | The input string to convert to Title Case |
+
+| Parameter | Type   | Default  | Description                               |
+| --------- | ------ | -------- | ----------------------------------------- |
+| text      | string | required | The input string to convert to Title Case |
 
 #### <a id="constantcase"></a>`constantCase(text)`
+
 Converts the given string to Constant Case.
 
 ```javascript
 import { constantCase } from 'stringzy';
 
-
 constantCase('hello world'); // 'HELLO_WORLD'
 constantCase('this is a test'); // 'THIS_IS_A_TEST'
-
 ```
-| Parameter | Type | Default | Description |
-|-----------|------|---------|-------------|
-| text | string | required | The input string to convert to Constant Case |
+
+| Parameter | Type   | Default  | Description                                  |
+| --------- | ------ | -------- | -------------------------------------------- |
+| text      | string | required | The input string to convert to Constant Case |
 
 #### <a id="escapehtml"></a>`escapeHTML(text)`
 
@@ -382,12 +385,13 @@ escapeHTML('Say "Hello" & it\'s < 5 > 2');
 // Returns: 'Say &quot;Hello&quot; &amp; it&#39;s &lt; 5 &gt; 2'
 ```
 
-| Parameter | Type | Default | Description |
-|-----------|------|---------|-------------|
-| text | string | required | The input string to escape HTML characters from |
+| Parameter | Type   | Default  | Description                                     |
+| --------- | ------ | -------- | ----------------------------------------------- |
+| text      | string | required | The input string to escape HTML characters from |
 
 #### <a id="masksegment"></a>`maskSegment(text, maskStart, maskEnd, maskChar?)`
-Masks a segment of a string by replacing characters between two indices with a specified character (default is '*').
+
+Masks a segment of a string by replacing characters between two indices with a specified character (default is '\*').
 
 ```javascript
 import { maskSegment } from 'stringzy';
@@ -400,16 +404,17 @@ maskSegment('abcdef', 1, 4, '#');
 
 maskSegment('token');
 // Returns: '*****'
-
 ```
-| Parameter |	Type | Default| Description | 
-|-----------|------|--------|-------------|
-|text	| string | required |	The input string to apply the masking to|
-|maskStart	|number|	`0`|	The start index (inclusive) of the segment to mask|
-|maskEnd	|number|	`text.length`|	The end index (exclusive) of the segment to mask|
-|maskChar	|string	|`'*'` |	The character to use for masking (must be one character)|
+
+| Parameter | Type   | Default       | Description                                              |
+| --------- | ------ | ------------- | -------------------------------------------------------- |
+| text      | string | required      | The input string to apply the masking to                 |
+| maskStart | number | `0`           | The start index (inclusive) of the segment to mask       |
+| maskEnd   | number | `text.length` | The end index (exclusive) of the segment to mask         |
+| maskChar  | string | `'*'`         | The character to use for masking (must be one character) |
 
 #### <a id="deburr"></a>deburr(text)
+
 Removes accents and diacritics from letters in a string (e.g. déjà vu → deja vu).
 
 ```javascript
@@ -423,14 +428,55 @@ deburr('Élève São Paulo');
 
 deburr('über cool');
 // Returns: 'uber cool'
-
 ```
-| Parameter | Type   | Default |  Description                               |
+
+| Parameter | Type   | Default  | Description                               |
 | --------- | ------ | -------- | ----------------------------------------- |
 | text      | string | required | The input string to strip diacritics from |
 
 ---
 
+#### <a id="splitchunks"></a>`splitChunks(text, chunkSize)`
+
+Takes a string and chunk size as the argument and splits the string into chunks of given size.
+
+```javascript
+import { splitChunks } from 'stringzy';
+
+splitChunks('helloworld', 2);
+// Returns: ['he', 'll', 'ow', 'or', 'ld']
+
+splitChunks('helloworld', 3);
+// Returns: ['hel', 'low', 'orl', 'd']
+
+splitChunks('helloworld');
+// Returns: ['h', 'e', 'l', 'l', 'o', 'w', 'o', 'r', 'l', 'd']
+```
+
+| Parameter | Type   | Default  | Description                                               |
+| --------- | ------ | -------- | --------------------------------------------------------- |
+| text      | string | required | The input string that needs to be chunked                 |
+| chunkSize | number | `1`      | The size of each chunk in which the string is to be split |
+
+---
+#### <a id="numbertotext"></a>`numberToText(num, lang)`
+Converts a number to its text representation in the specified language.
+
+```javascript
+import { numberToText } from 'stringzy';
+numberToText(12345); // Returns: 'twelve thousand three hundred forty-five'
+numberToText(12345, 'en'); // Returns: 'twelve thousand three hundred forty-five'
+numberToText(12345, 'pl'); // Returns: 'dwanaście tysięcy trzysta czterdzieści pięć'
+```
+
+| Parameter | Type   | Default | Description |
+|-----------|--------|---------|-------------|
+| num       | number | required | The number to convert to text |
+| lang      | string | 'en'    | The language code for the text representation (e.g., 'en' for English, 'pl' for Polish) |
+
+Available languages: en (English), pl (Polish).
+
+
 ### ✅ Validations
 
 Functions for validating string formats and content.
@@ -444,9 +490,9 @@ isURL('https://example.com'); // true
 isURL('not-a-url'); // false
 ```
 
-| Parameter | Type | Default | Description |
-|-----------|------|---------|-------------|
-| text | string | required | The input string to validate as URL |
+| Parameter | Type   | Default  | Description                         |
+| --------- | ------ | -------- | ----------------------------------- |
+| text      | string | required | The input string to validate as URL |
 
 #### <a id="isemail"></a>`isEmail(text)`
 
@@ -457,9 +503,9 @@ isEmail('user@example.com'); // true
 isEmail('invalid-email'); // false
 ```
 
-| Parameter | Type | Default | Description |
-|-----------|------|---------|-------------|
-| text | string | required | The input string to validate as email |
+| Parameter | Type   | Default  | Description                           |
+| --------- | ------ | -------- | ------------------------------------- |
+| text      | string | required | The input string to validate as email |
 
 #### <a id="isdate"></a>`isDate(text)`
 
@@ -476,11 +522,11 @@ isDate('invalid-date', DateFormat.YYYMMDD); // false
 isDate('2023-13-45', DateFormat.YYYMMDD); // false
 ```
 
-| Parameter | Type | Default | Description |
-|-----------|------|---------|-------------|
-| input | string | required | The input string to validate as date |
-| format | DateFormats | required | The date format to validate against |
-| separator | string | optional | The separator to be used if it is not "-" |
+| Parameter | Type        | Default  | Description                               |
+| --------- | ----------- | -------- | ----------------------------------------- |
+| input     | string      | required | The input string to validate as date      |
+| format    | DateFormats | required | The date format to validate against       |
+| separator | string      | optional | The separator to be used if it is not "-" |
 
 #### <a id="isempty"></a>`isEmpty(text)`
 
@@ -491,26 +537,45 @@ isEmpty('   '); // true
 isEmpty('hello'); // false
 ```
 
-| Parameter | Type | Default | Description |
-|-----------|------|---------|-------------|
-| text | string | required | The input string to check for emptiness |
+| Parameter | Type   | Default  | Description                             |
+| --------- | ------ | -------- | --------------------------------------- |
+| text      | string | required | The input string to check for emptiness |
 
 #### <a id="isslug"></a>`isSlug(text)`
 
 Checks if a string is a valid slug.
 
 ```javascript
-isSlug("hello-world");         // true
-isSlug("test-product-123");    // true
-isSlug("Hello-World");         // false (uppercase letters)
-isSlug("hello--world");        // false (consecutive hyphens)
-isSlug("-hello-world");        // false (starts with hyphen)
-isSlug("hello_world");         // false (underscore not allowed)
+isSlug('hello-world'); // true
+isSlug('test-product-123'); // true
+isSlug('Hello-World'); // false (uppercase letters)
+isSlug('hello--world'); // false (consecutive hyphens)
+isSlug('-hello-world'); // false (starts with hyphen)
+isSlug('hello_world'); // false (underscore not allowed)
+```
+
+| Parameter | Type   | Default  | Description                          |
+| --------- | ------ | -------- | ------------------------------------ |
+| text      | string | required | The input string to validate as slug |
+
+#### <a id="istypeof"></a>`isTypeOf(input, type)`
+
+Checks if a file or URL has a valid extension for a given type
+
+```javascript
+isType("photo.PNG", "image");                    // true
+isType("https://example.com/logo.svg", "image"); // true
+isType({ name: "track.mp3" }, "audio");          // true
+isType("filewithoutextension", "image");         // false
+isType("document.zip", "document");              // false
+isType("video.mp4", "document");                 // false
 ```
 
 | Parameter | Type | Default | Description |
 |-----------|------|---------|-------------|
-| text | string | required | The input string to validate as slug |
+| input | string | required | The file name, URL string, or object with .name |
+| input | string | required | The file type category to validate (image, video, audio, document, archive) |
+
 
 #### <a id="isipv4"></a>`isIPv4(text)`
 
@@ -527,10 +592,9 @@ isIPv4('192.168.01.1'); // false (leading zeros)
 isIPv4('192.168.1.a'); // false (non-numeric)
 ```
 
-| Parameter | Type | Default | Description |
-|-----------|------|---------|-------------|
-| text | string | required | The input string to validate as IPv4 address |
-
+| Parameter | Type   | Default  | Description                                  |
+| --------- | ------ | -------- | -------------------------------------------- |
+| text      | string | required | The input string to validate as IPv4 address |
 
 #### <a id="ishexcolor"></a>`isHexColor(text)`
 
@@ -539,21 +603,57 @@ Checks if a string is a valid Hex color.
 ```javascript
 import { isHexColor } from 'stringzy';
 
-isHexColor('#fff');       // true
-isHexColor('fff');        // true
-isHexColor('#a1b2c3');    // true
-isHexColor('123abc');     // true
-isHexColor('#1234');      // false
-isHexColor('blue');       // false
+isHexColor('#fff'); // true
+isHexColor('fff'); // true
+isHexColor('#a1b2c3'); // true
+isHexColor('123abc'); // true
+isHexColor('#1234'); // false
+isHexColor('blue'); // false
 ```
 
-| Parameter | Type | Default | Description |
-|-----------|------|---------|-------------|
-| text | string | required | The input string to validate as Hex color |
+| Parameter | Type   | Default  | Description                               |
+| --------- | ------ | -------- | ----------------------------------------- |
+| text      | string | required | The input string to validate as Hex color |
 
----
+#### <a id="ispalindrome"></a>`isPalindrome(text)`
+
+Checks if a string is a palindrome.
+The check is case-insensitive and ignores spaces and punctuation.
+
+```javascript
+import { isPalindrome } from 'stringzy';
+
+isPalindrome('racecar');                            // true
+isPalindrome('A man, a plan, a canal: Panama');     // true
+isPalindrome('No lemon, no melon');                 // true
+isPalindrome('hello');                              // false
+isPalindrome('Was it a car or a cat I saw?');       // true
+```
+
+| Parameter | Type   | Default  | Description                              |
+| --------- | ------ | -------- | ---------------------------------------- |
+| text      | string | required | The input string to check for palindrome |
+
+#### <a id="iscoordinates"></a>`isCoordinates(latitude, longitude)`
+
+Checks if given latitude and longitude are valid coordinates.
+
+```javascript
+import { isCoordinates } from 'stringzy';
+
+isCoordinates(48.8582, 2.2945); // true
+isCoordinates(40.748817, -73.985428); // true
+isCoordinates(9999, -9999); // false
+```
+
+| Parameter | Type        | Default  | Description                               |
+| --------- | ----------- | -------- | ----------------------------------------- |
+| latitude  | number      | required | Latitude to validate                      |
+| longitude | number      | required | Longitude to validate                     |
 
 
+---
+
 ### 📊 Analysis
 
 Functions for analyzing string content and structure.
@@ -565,21 +665,25 @@ Calculates the estimated reading duration for a given text based on an average r
 ```javascript
 import { readingDuration } from 'stringzy';
 
-readingDuration('This is a sample text with twenty-three words to test the reading duration function.');
+readingDuration(
+  'This is a sample text with twenty-three words to test the reading duration function.'
+);
 // Returns: 0 (23 words / 230 words per minute ≈ 0 minutes)
 
-readingDuration('This text contains fifty words. It is designed to test the reading duration function with a larger input.', 200);
+readingDuration(
+  'This text contains fifty words. It is designed to test the reading duration function with a larger input.',
+  200
+);
 // Returns: 1 (50 words / 200 words per minute ≈ 1 minute)
 
 readingDuration(Array(9999).fill('Word').join(' '));
 // Returns: 43 (9999 words / 230 words per minute ≈ 43 minutes)
 ```
 
-| Parameter      | Type     | Default | Description                                                                 |
-|----------------|----------|---------|-----------------------------------------------------------------------------|
-| text           | string   | required | The input text for which the reading duration is to be calculated           |
-| readingSpeed   | number   | 230     | The reading speed in words per minute. Defaults to 230 (average reading speed) |
-
+| Parameter    | Type   | Default  | Description                                                                    |
+| ------------ | ------ | -------- | ------------------------------------------------------------------------------ |
+| text         | string | required | The input text for which the reading duration is to be calculated              |
+| readingSpeed | number | 230      | The reading speed in words per minute. Defaults to 230 (average reading speed) |
 
 #### <a id="wordcount"></a>`wordCount(text)`
 
@@ -590,9 +694,9 @@ wordCount('Hello world'); // 2
 wordCount(''); // 0
 ```
 
-| Parameter | Type | Default | Description |
-|-----------|------|---------|-------------|
-| text | string | required | The input string to count words in |
+| Parameter | Type   | Default  | Description                        |
+| --------- | ------ | -------- | ---------------------------------- |
+| text      | string | required | The input string to count words in |
 
 #### <a id="charactercount"></a>`characterCount(text)`
 
@@ -602,9 +706,9 @@ Counts the number of characters in a string.
 characterCount('Hello'); // 5
 ```
 
-| Parameter | Type | Default | Description |
-|-----------|------|---------|-------------|
-| text | string | required | The input string to count characters in |
+| Parameter | Type   | Default  | Description                             |
+| --------- | ------ | -------- | --------------------------------------- |
+| text      | string | required | The input string to count characters in |
 
 #### <a id="characterfrequency"></a>`characterFrequency(text)`
 
@@ -614,14 +718,15 @@ Analyzes character frequency in a string (excluding spaces).
 characterFrequency('hello'); // { h: 1, e: 1, l: 2, o: 1 }
 ```
 
-| Parameter | Type | Default | Description |
-|-----------|------|---------|-------------|
-| text | string | required | The input string to analyze character frequency |
+| Parameter | Type   | Default  | Description                                     |
+| --------- | ------ | -------- | ----------------------------------------------- |
+| text      | string | required | The input string to analyze character frequency |
 
 #### <a id="stringsimilarity"></a>`stringSimilarity(textA, textB, algorithm = 'Levenshtein')`
 
 Calculates the percentage similarity between two texts using the selected algorithm.
 Method returns a percentage (0–100) value indicating how similar the two strings are.
+
 ```javascript
 stringSimilarity('kitten', 'sitting'); // Returns: 57.14
 
@@ -630,11 +735,79 @@ stringSimilarity('hello', 'hello'); // Returns: 100
 stringSimilarity('flaw', 'lawn', 'Damerau-Levenshtein'); // Returns: 50
 ```
 
-| Parameter  | Type   | Default              | Description                                                                 |
-|------------|--------|----------------------|-----------------------------------------------------------------------------|
-| textA      | string | required             | The first text to compare.                                                  |
-| textB      | string | required             | The second text to compare.                                                 |
-| algorithm  | string | 'Levenshtein'        | The algorithm to use: 'Levenshtein' or 'Damerau-Levenshtein'.               |
+| Parameter | Type   | Default       | Description                                                   |
+| --------- | ------ | ------------- | ------------------------------------------------------------- |
+| textA     | string | required      | The first text to compare.                                    |
+| textB     | string | required      | The second text to compare.                                   |
+| algorithm | string | 'Levenshtein' | The algorithm to use: 'Levenshtein' or 'Damerau-Levenshtein'. |
+
+
+
+#### <a id="complexity"></a>`complexity(text)`
+
+Analyzes the complexity of a string, returning an object with detailed metrics.
+
+```javascript
+import { complexity } from 'stringzy';
+
+complexity('abc');
+// Returns: { score: [number], uniqueness: [number], length: 3 }
+
+complexity('aA1!aA1!');
+// Returns: { score: [number], uniqueness: [number], length: 8 }
+
+complexity('');
+// Returns: { score: 0, uniqueness: 0, length: 0 }
+```
+
+| Parameter | Type   | Default  | Description                            |
+| --------- | ------ | -------- | -------------------------------------- |
+| text      | string | required | The input string to analyze complexity |
+
+**Returns:** An object containing:
+
+- `score` (number): Overall complexity score
+- `uniqueness` (number): Measure of character uniqueness
+- `length` (number): Length of the input string
+
+
+
+#### <a id="patterncount"></a>`patternCount(text, pattern)`
+
+Counts the number of times a substring (pattern) occurs in a string, including overlapping occurrences.  
+This function uses the **Knuth–Morris–Pratt (KMP)** algorithm for efficient matching.
+
+```javascript
+patternCount('aaaa', 'aa'); // 3
+patternCount('abababa', 'aba'); // 3
+patternCount('hello world', 'o'); // 2
+patternCount('hello world', 'x'); // 0
+```
+
+| Parameter | Type   | Default  | Description                                    |
+| --------- | ------ | -------- | ---------------------------------------------- |
+| text      | string | required | The input string to search in                  |
+| pattern   | string | required | The substring (pattern) to count (overlapping) |
+
+#### <a id="vowelconsonantcount"></a>`vowelConsonantCount(str)`
+
+Counts the number of vowels and consonants in a given string.  
+This function is case-insensitive and ignores non-alphabetic characters.
+
+```javascript
+vowelConsonantCount('hello'); 
+// { vowels: 2, consonants: 3 }
+
+vowelConsonantCount('stringzy');
+// { vowels: 1, consonants: 7 }
+
+vowelConsonantCount('');
+// { vowels: 0, consonants: 0 }
+```
+
+| Parameter | Type   | Default  | Description                                        |
+| --------- | ------ | -------- | -------------------------------------------------- |
+| str       | string | required | The input string to count vowels and consonants in |
 
 ---
 
@@ -651,9 +824,9 @@ capitalize('hello world'); // 'Hello World'
 capitalize('javaScript programming'); // 'Javascript Programming'
 ```
 
-| Parameter | Type | Default | Description |
-|-----------|------|---------|-------------|
-| text | string | required | The input string to capitalize |
+| Parameter | Type   | Default  | Description                    |
+| --------- | ------ | -------- | ------------------------------ |
+| text      | string | required | The input string to capitalize |
 
 #### <a id="formatnumber"></a>`formatNumber(number, separator = ',')`
 
@@ -664,10 +837,10 @@ formatNumber('1234567'); // '1,234,567'
 formatNumber('1234567', '.'); // '1.234.567'
 ```
 
-| Parameter | Type | Default | Description |
-|-----------|------|---------|-------------|
-| number | string\|number | required | The number to format |
-| separator | string | ',' | The separator to use for thousands |
+| Parameter | Type           | Default  | Description                        |
+| --------- | -------------- | -------- | ---------------------------------- |
+| number    | string\|number | required | The number to format               |
+| separator | string         | ','      | The separator to use for thousands |
 
 #### <a id="formatphone"></a>`formatPhone(phone, format = 'us')`
 
@@ -678,14 +851,15 @@ formatPhone('1234567890'); // '(123) 456-7890'
 formatPhone('11234567890', 'international'); // '+1 (123) 456-7890'
 ```
 
-| Parameter | Type | Default | Description |
-|-----------|------|---------|-------------|
-| phone | string | required | The phone number string to format |
-| format | string | 'us' | Format type: 'us' or 'international' |
+| Parameter | Type   | Default  | Description                          |
+| --------- | ------ | -------- | ------------------------------------ |
+| phone     | string | required | The phone number string to format    |
+| format    | string | 'us'     | Format type: 'us' or 'international' |
 
 ## 🔧 Usage Patterns
 
 ### Individual Function Imports
+
 ```javascript
 import { isEmail, wordCount, capitalize } from 'stringzy';
 
@@ -696,6 +870,7 @@ if (isEmail(email)) {
 ```
 
 ### Namespace Imports
+
 ```javascript
 import { validate, analyze, format } from 'stringzy';
 
@@ -706,6 +881,7 @@ const formatted = format.capitalize('hello world');
 ```
 
 ### Default Import (All Functions)
+
 ```javascript
 import stringzy from 'stringzy';
 
@@ -746,19 +922,19 @@ import { validate } from 'stringzy';
 
 function validateForm(formData) {
   const errors = {};
-  
+
   if (!validate.isEmail(formData.email)) {
     errors.email = 'Please enter a valid email address';
   }
-  
+
   if (!validate.isURL(formData.website)) {
     errors.website = 'Please enter a valid URL';
   }
-  
+
   if (validate.isEmpty(formData.name)) {
     errors.name = 'Name is required';
   }
-  
+
   return errors;
 }
 ```
@@ -773,7 +949,7 @@ function getContentStats(text) {
     words: analyze.wordCount(text),
     characters: analyze.characterCount(text),
     frequency: analyze.characterFrequency(text),
-    readingTime: Math.ceil(analyze.wordCount(text) / 200)
+    readingTime: Math.ceil(analyze.wordCount(text) / 200),
   };
 }
 ```
@@ -787,7 +963,7 @@ function formatUserData(userData) {
   return {
     name: format.capitalize(userData.name),
     phone: format.formatPhone(userData.phone),
-    revenue: format.formatNumber(userData.revenue)
+    revenue: format.formatNumber(userData.revenue),
   };
 }
 ```
@@ -810,7 +986,7 @@ const formatted: string = format.capitalize('hello world');
 stringzy is organized into four specialized modules:
 
 - **`transformations.js`** - Core string transformations
-- **`validations.js`** - String validation utilities  
+- **`validations.js`** - String validation utilities
 - **`analysis.js`** - String analysis and metrics
 - **`formatting.js`** - String formatting functions
 
@@ -820,7 +996,6 @@ Each module can be imported individually or accessed through the main entry poin
 
 Contributions are welcome! Please read our [contribution guidelines](CONTRIBUTING.md) before submitting a pull request.
 
-
 ## <a id="contri"></a>`Contributors`
 
 <table>
@@ -928,6 +1103,68 @@ Contributions are welcome! Please read our [contribution guidelines](CONTRIBUTIN
                     </sub>
                 </a>
             </td>
+            <td align="center">
+                <a href="https://github.com/Thenlie">
+                    <img src="https://avatars.githubusercontent.com/Thenlie" width="100px;"
+                        alt="Thenlie" />
+                    <br />
+                    <sub>
+                        <b>Leithen</b>
+                    </sub>
+                </a>
+            </td>
+        <td align="center">
+                <a href="https://github.com/rickyryden">
+                    <img src="https://avatars.githubusercontent.com/rickyryden" width="100px;"
+                        alt="Ricky Ryden" />
+                    <br />
+                    <sub>
+                        <b>Ricky Ryden</b>
+                    </sub>
+                </a>
+            </td>
+      </tr>
+      <tr>
+        <td align="center">
+                <a href="https://github.com/adityaatre26">
+                    <img src="https://avatars.githubusercontent.com/adityaatre26" width="100px;"
+                        alt="Aditya Atre" />
+                    <br />
+                    <sub>
+                        <b>Aditya Atre</b>
+                    </sub>
+                </a>
+            </td>
+         <td align="center">
+                <a href="https://github.com/kittenwarrior-qb">
+                    <img src="https://avatars.githubusercontent.com/kittenwarrior-qb" width="100px;"
+                        alt="quocbui05" />
+                    <br />
+                    <sub>
+                        <b>quocbui05</b>
+                    </sub>
+                </a>
+            </td>
+        <td align="center">
+                <a href="https://github.com/MariamEwas">
+                    <img src="https://avatars.githubusercontent.com/MariamEwas" width="100px;"
+                        alt="Mariam Hasan" />
+                    <br />
+                    <sub>
+                        <b>Mariam Hasan</b>
+                    </sub>
+                </a>
+            </td>
+        <td align="center">
+                <a href="https://github.com/milendrakumarbaghel">
+                    <img src="https://avatars.githubusercontent.com/milendrakumarbaghel" width="100px;"
+                        alt="Mariam Hasan" />
+                    <br />
+                    <sub>
+                        <b>Milendra Kumar Baghel</b>
+                    </sub>
+                </a>
+            </td>
       </tr>
     </tbody>
 </table>