@pawells/typescript-common 1.4.1 → 2.1.5

package/dist/object/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/object/types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AACH,MAAM,MAAM,0BAA0B,CAAC,CAAC,EAAE,CAAC,IAAI;KAC7C,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK;CAC1C,CAAC;AACF;;;;;;;;GAQG;AACH,MAAM,MAAM,iBAAiB,CAAC,CAAC,SAAS,MAAM,IAAI,MAAM,CAAC,CAAC;AAC1D;;;;;;;;;;GAUG;AACH,MAAM,MAAM,uBAAuB,CAAC,CAAC,SAAS,MAAM,EAAE,YAAY,IAAI,MAAM;KAC1E,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,YAAY,GAAG,CAAC,GAAG,KAAK,GAAG,OAAO;CAChE,CAAC;AACF;;;;;;;;;;GAUG;AACH,MAAM,MAAM,2BAA2B,CAAC,CAAC,SAAS,MAAM,EAAE,YAAY,IAAI;KACxE,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,YAAY,GAAG,KAAK,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CAC7D,CAAC;AACF;;;;;;;;GAQG;AACH,MAAM,MAAM,mBAAmB,CAAC,CAAC,SAAS,MAAM,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;AAC/D;;;;;;;;;;GAUG;AACH,MAAM,MAAM,uBAAuB,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,MAAM,IAAI;KACxE,CAAC,IAAI,MAAM,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,SAAS,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK;CAC1D,CAAC;AACF;;;;;;;;;GASG;AACH,MAAM,MAAM,sBAAsB,CAAC,CAAC,SAAS,MAAM,IAAI;KACrD,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,KAAK;CACvD,CAAC,MAAM,CAAC,CAAC,CAAC;AAEX;;;;;;;;;;GAUG;AACH,MAAM,MAAM,kBAAkB,CAAC,UAAU,SAAS,MAAM,IAAI;KAAG,GAAG,IAAI,MAAM,UAAU,GAAG,CAAC,MAAM,GAAG,MAAM,CAAC,GAAG,UAAU,CAAC,GAAG,CAAC,SAAS,MAAM,GAAG,GAAG,GAAG,EAAE,GAAG,GAAG,GAAG,IAAI,kBAAkB,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,EAAE,GAAG,GAAG,GAAG,EAAE;CAAE,CAAC,MAAM,UAAU,GAAG,CAAC,MAAM,GAAG,MAAM,CAAC,CAAC,CAAC;AAE5P;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACpC,4HAA4H;IAC5H,YAAY,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IACnC,8EAA8E;IAC9E,sBAAsB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC7C,iHAAiH;IACjH,aAAa,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;CACpC;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IAC1C,qGAAqG;IACrG,YAAY,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAClC,4HAA4H;IAC5H,YAAY,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IACnC,8EAA8E;IAC9E,sBAAsB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC7C,iHAAiH;IACjH,aAAa,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;CACpC;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACvC,0FAA0F;IAC1F,YAAY,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAClC;AAED;;;GAGG;AACH,MAAM,MAAM,2BAA2B,CAAC,CAAC,SAAS,MAAM,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;AAEtI;;;GAGG;AACH,MAAM,MAAM,2BAA2B,CAAC,CAAC,SAAS,MAAM,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,eAAe,CAAC,CAAC,CAAC,EAAE,SAAS,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC;AAE7J;;;;;GAKG;AACH,MAAM,MAAM,gBAAgB,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,IAAI,CAAC,GAAG,EAAE,CAAC,KAAK,OAAO,CAAC;AAE9E;;;;;;GAMG;AACH,MAAM,MAAM,kBAAkB,CAAC,MAAM,SAAS,MAAM,GAAG,MAAM,EAAE,OAAO,SAAS,MAAM,GAAG,MAAM,IAAI,CACjG,KAAK,EAAE,MAAM,KACT,OAAO,CAAC;AAEb;;;;;;GAMG;AACH,MAAM,MAAM,iBAAiB,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,MAAM,CAAC;AAElF;;;;;;GAMG;AACH,MAAM,MAAM,yBAAyB,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,OAAO,CAAC;AAE3F;;;;;;;GAOG;AACH,MAAM,MAAM,eAAe,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,EAAE,CAAC,SAAS,MAAM,CAAC,GAAG,MAAM,CAAC,IAAI,CACrF,GAAG,EAAE,CAAC,EACN,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,KACP,OAAO,CAAC;AAEb;;;;;;;GAOG;AACH,MAAM,MAAM,eAAe,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,EAAE,CAAC,SAAS,MAAM,CAAC,GAAG,MAAM,CAAC,IAAI,CACrF,GAAG,EAAE,CAAC,EACN,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,KACP,OAAO,CAAC"}

package/dist/object/types.js

@@ -0,0 +1 @@
+export {};

package/{build → dist}/string/assert.d.ts

@@ -3,8 +3,13 @@ import { SimpleError } from '../asserts/errors.js';
 /**
  * Error thrown when a value is not a valid string or fails a string assertion.
  *
+ * @returns A StringError instance with the provided message
+ * @throws N/A - This is an error class constructor
+ *
  * @example
+ * ```typescript
  * throw new StringError('Value is not a valid string');
+ * ```
  */
 export declare class StringError extends SimpleError {
     constructor(message?: string);

package/dist/string/assert.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"assert.d.ts","sourceRoot":"","sources":["../../src/string/assert.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAE5D,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AA8CnD;;;;;;;;;;GAUG;AACH,qBAAa,WAAY,SAAQ,WAAW;gBAC/B,OAAO,CAAC,EAAE,MAAM;CAG5B;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE,OAAO,EAAE,SAAS,GAAE,gBAAqB,GAAG,OAAO,CAAC,KAAK,IAAI,MAAM,CAGtG;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,OAAO,EAAE,SAAS,GAAE,gBAAqB,GAAG,OAAO,CAAC,KAAK,IAAI,MAAM,CAY9G;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AACH,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,SAAS,GAAE,gBAAqB,GAAG,IAAI,CAsBxG"}

package/{build → dist}/string/assert.js

@@ -1,4 +1,4 @@
-import { SetExceptionClass, SetExceptionMessage, ThrowException } from '../asserts/utils.js';
+import { SetExceptionClass, SetExceptionMessage, ThrowException, AssertValueType } from '../asserts/utils.js';
 import { SimpleError } from '../asserts/errors.js';
 import { LRUCache } from '../lru-cache.js';
 /**
@@ -19,6 +19,12 @@ const REGEX_PATTERN_CACHE = new LRUCache(MAX_CACHE_SIZE);
  * Gets a cached regex pattern or creates and caches a new one.
  * This optimization improves performance when the same regex patterns are used repeatedly.
  *
+ * The cache key format `${source}:::${flags}` is safe because:
+ * - The `source` parameter is validated by RegExp constructor (throws on invalid patterns)
+ * - The `flags` parameter is validated by RegExp constructor (throws on invalid flags)
+ * - No user-supplied input is included in the cache key beyond these validated components
+ * - The separator ':::' cannot appear in valid regex flags, preventing key collision
+ *
  * @param source - The regex pattern source string
  * @param flags - The regex flags string
  * @returns The compiled RegExp object
@@ -37,8 +43,13 @@ function getCachedRegex(source, flags = '') {
 /**
  * Error thrown when a value is not a valid string or fails a string assertion.
  *
+ * @returns A StringError instance with the provided message
+ * @throws N/A - This is an error class constructor
+ *
  * @example
+ * ```typescript
  * throw new StringError('Value is not a valid string');
+ * ```
  */
 export class StringError extends SimpleError {
     constructor(message) {
@@ -69,10 +80,7 @@ export class StringError extends SimpleError {
  */
 export function AssertString(value, exception = {}) {
     SetExceptionClass(exception, StringError);
-    if (typeof value !== 'string') {
-        SetExceptionMessage(exception, `Expected string but received ${typeof value}: ${String(value)}`);
-        ThrowException(exception);
-    }
+    AssertValueType(value, 'string', exception);
 }
 /**
  * Asserts that a value is a non-empty string (after trimming whitespace).
@@ -100,10 +108,7 @@ export function AssertString(value, exception = {}) {
  */
 export function AssertStringNotEmpty(value, exception = {}) {
     SetExceptionClass(exception, StringError);
-    if (typeof value !== 'string') {
-        SetExceptionMessage(exception, `Expected non-empty string but received ${typeof value}: ${String(value)}`);
-        ThrowException(exception);
-    }
+    AssertValueType(value, 'string', exception);
     const str = value;
     if (str === '') {
         SetExceptionMessage(exception, 'Expected non-empty string but received empty string');
@@ -175,4 +180,3 @@ export function AssertStringMatches(value, regex, exception = {}) {
         ThrowException(exception);
     }
 }
-//# sourceMappingURL=assert.js.map

package/dist/string/case-conversion.d.ts

@@ -0,0 +1,79 @@
+/**
+ * Converts a string to camelCase.
+ *
+ * @param value - The input string
+ * @returns The camelCased string
+ *
+ * @example
+ * ```typescript
+ * CamelCase('Hello-World'); // 'helloWorld'
+ * CamelCase('hello_world'); // 'helloWorld'
+ * ```
+ */
+export declare function CamelCase(value: string): string;
+/**
+ * Capitalizes the first letter of a string.
+ *
+ * @param value - The input string
+ * @returns The capitalized string
+ *
+ * @example
+ * ```typescript
+ * Capitalize('hello'); // 'Hello'
+ * Capitalize('hello world'); // 'Hello world'
+ * ```
+ */
+export declare function Capitalize(value: string): string;
+/**
+ * Converts a string to kebab-case.
+ *
+ * @param value - The input string
+ * @returns The kebab-cased string
+ *
+ * @example
+ * ```typescript
+ * KebabCase('HelloWorld'); // 'hello-world'
+ * KebabCase('hello_world'); // 'hello-world'
+ * ```
+ */
+export declare function KebabCase(value: string): string;
+/**
+ * Converts a string to PascalCase.
+ *
+ * @param value - The input string
+ * @returns The PascalCased string
+ *
+ * @example
+ * ```typescript
+ * PascalCase('hello-world'); // 'HelloWorld'
+ * PascalCase('hello_world'); // 'HelloWorld'
+ * ```
+ */
+export declare function PascalCase(value: string): string;
+/**
+ * Converts a string to snake_case.
+ *
+ * @param value - The input string
+ * @returns The snake_cased string
+ *
+ * @example
+ * ```typescript
+ * SnakeCase('HelloWorld'); // 'hello_world'
+ * SnakeCase('hello-world'); // 'hello_world'
+ * ```
+ */
+export declare function SnakeCase(value: string): string;
+/**
+ * Converts a string to SCREAMING_SNAKE_CASE.
+ *
+ * @param value - The input string
+ * @returns The SCREAMING_SNAKE_CASED string
+ *
+ * @example
+ * ```typescript
+ * ScreamingSnakeCase('HelloWorld'); // 'HELLO_WORLD'
+ * ScreamingSnakeCase('hello-world'); // 'HELLO_WORLD'
+ * ```
+ */
+export declare function ScreamingSnakeCase(value: string): string;
+//# sourceMappingURL=case-conversion.d.ts.map

package/dist/string/case-conversion.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"case-conversion.d.ts","sourceRoot":"","sources":["../../src/string/case-conversion.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AACH,wBAAgB,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAY/C;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAMhD;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAS/C;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAYhD;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAS/C;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAExD"}

package/{build → dist}/string/case-conversion.js

@@ -1,9 +1,14 @@
 /**
  * Converts a string to camelCase.
  *
- * @param value The input string.
- * @returns The camelCased string.
- * @see {@link TCaseConverter}
+ * @param value - The input string
+ * @returns The camelCased string
+ *
+ * @example
+ * ```typescript
+ * CamelCase('Hello-World'); // 'helloWorld'
+ * CamelCase('hello_world'); // 'helloWorld'
+ * ```
  */
 export function CamelCase(value) {
     if (value && typeof value === 'string') {
@@ -20,24 +25,34 @@ export function CamelCase(value) {
 /**
  * Capitalizes the first letter of a string.
  *
- * @param value The input string.
- * @returns The capitalized string.
- * @see {@link TCaseConverter}
+ * @param value - The input string
+ * @returns The capitalized string
+ *
+ * @example
+ * ```typescript
+ * Capitalize('hello'); // 'Hello'
+ * Capitalize('hello world'); // 'Hello world'
+ * ```
  */
-export const CAPITALIZE = (value) => {
+export function Capitalize(value) {
     if (value && typeof value === 'string') {
         return value.charAt(0).toUpperCase() + value.slice(1);
     }
     return '';
-};
+}
 /**
  * Converts a string to kebab-case.
  *
- * @param value The input string.
- * @returns The kebab-cased string.
- * @see {@link TCaseConverter}
+ * @param value - The input string
+ * @returns The kebab-cased string
+ *
+ * @example
+ * ```typescript
+ * KebabCase('HelloWorld'); // 'hello-world'
+ * KebabCase('hello_world'); // 'hello-world'
+ * ```
  */
-export const KEBAB_CASE = (value) => {
+export function KebabCase(value) {
     if (value && typeof value === 'string') {
         return value
             .replace(/(?<lower>[a-z])(?<upper>[A-Z])/gu, '$1-$2')
@@ -45,15 +60,20 @@ export const KEBAB_CASE = (value) => {
             .toLowerCase();
     }
     return '';
-};
+}
 /**
  * Converts a string to PascalCase.
  *
- * @param value The input string.
- * @returns The PascalCased string.
- * @see {@link TCaseConverter}
+ * @param value - The input string
+ * @returns The PascalCased string
+ *
+ * @example
+ * ```typescript
+ * PascalCase('hello-world'); // 'HelloWorld'
+ * PascalCase('hello_world'); // 'HelloWorld'
+ * ```
  */
-export const PASCAL_CASE = (value) => {
+export function PascalCase(value) {
     if (value && typeof value === 'string') {
         return value
             .replace(/(?:^\w|[A-Z]|\b\w)/gu, (word) => {
@@ -64,15 +84,20 @@ export const PASCAL_CASE = (value) => {
         });
     }
     return '';
-};
+}
 /**
  * Converts a string to snake_case.
  *
- * @param value The input string.
- * @returns The snake_cased string.
- * @see {@link TCaseConverter}
+ * @param value - The input string
+ * @returns The snake_cased string
+ *
+ * @example
+ * ```typescript
+ * SnakeCase('HelloWorld'); // 'hello_world'
+ * SnakeCase('hello-world'); // 'hello_world'
+ * ```
  */
-export const SNAKE_CASE = (value) => {
+export function SnakeCase(value) {
     if (value && typeof value === 'string') {
         return value
             .replace(/(?<lower>[a-z])(?<upper>[A-Z])/gu, '$1_$2')
@@ -80,15 +105,19 @@ export const SNAKE_CASE = (value) => {
             .toLowerCase();
     }
     return '';
-};
+}
 /**
  * Converts a string to SCREAMING_SNAKE_CASE.
  *
- * @param value The input string.
- * @returns The SCREAMING_SNAKE_CASED string.
- * @see {@link TCaseConverter}
+ * @param value - The input string
+ * @returns The SCREAMING_SNAKE_CASED string
+ *
+ * @example
+ * ```typescript
+ * ScreamingSnakeCase('HelloWorld'); // 'HELLO_WORLD'
+ * ScreamingSnakeCase('hello-world'); // 'HELLO_WORLD'
+ * ```
  */
-export const SCREAMING_SNAKE_CASE = (value) => {
-    return SNAKE_CASE(value).toUpperCase();
-};
-//# sourceMappingURL=case-conversion.js.map
+export function ScreamingSnakeCase(value) {
+    return SnakeCase(value).toUpperCase();
+}

package/dist/string/comparison.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Compares two strings with optional case-insensitive matching.
+ *
+ * @param a - The first string to compare
+ * @param b - The second string to compare
+ * @param caseInsensitive - Whether to perform case-insensitive comparison (default: false)
+ * @returns True if the strings match according to the comparison mode
+ *
+ * @example
+ * ```typescript
+ * StringEquals('Hello', 'Hello'); // true
+ * StringEquals('Hello', 'hello'); // false
+ * StringEquals('Hello', 'hello', true); // true
+ * ```
+ *
+ * @see {@link IsBlankString}
+ * @see {@link Capitalize}
+ */
+export declare function StringEquals(a: string, b: string, caseInsensitive?: boolean): boolean;
+//# sourceMappingURL=comparison.d.ts.map

package/dist/string/comparison.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"comparison.d.ts","sourceRoot":"","sources":["../../src/string/comparison.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,eAAe,UAAQ,GAAG,OAAO,CAQnF"}

package/dist/string/comparison.js

@@ -0,0 +1,27 @@
+/**
+ * Compares two strings with optional case-insensitive matching.
+ *
+ * @param a - The first string to compare
+ * @param b - The second string to compare
+ * @param caseInsensitive - Whether to perform case-insensitive comparison (default: false)
+ * @returns True if the strings match according to the comparison mode
+ *
+ * @example
+ * ```typescript
+ * StringEquals('Hello', 'Hello'); // true
+ * StringEquals('Hello', 'hello'); // false
+ * StringEquals('Hello', 'hello', true); // true
+ * ```
+ *
+ * @see {@link IsBlankString}
+ * @see {@link Capitalize}
+ */
+export function StringEquals(a, b, caseInsensitive = false) {
+    if (caseInsensitive) {
+        // Note: toLowerCase() allocates a new string per call.
+        // For performance-critical loops (>1000 calls/sec), consider:
+        // a.localeCompare(b, undefined, { sensitivity: 'accent' }) which avoids allocations.
+        return a.toLowerCase() === b.toLowerCase();
+    }
+    return a === b;
+}

package/{build → dist}/string/formatting.d.ts

@@ -14,8 +14,8 @@ import type { TFormatParams, TFormatArgs } from './types.js';
  */
 export declare function EscapeHTML(str: string): string;
 /**
- * Formats a string by replacing placeholders with values
- * Supports both named placeholders {name} and positional {0}, {1}
+ * Formats a string by replacing placeholders with values.
+ * Supports both named placeholders {name} and positional {0}, {1}.
  *
  * @param template - The template string with placeholders
  * @param params - Either an object with named parameters or array of positional parameters
@@ -40,27 +40,40 @@ export declare function FormatString(template: string, params: TFormatParams | T
 /**
  * Truncates a string to a specified length, appending an ellipsis if truncated.
  *
- * @param str The string to truncate.
- * @param maxLength The maximum length before truncation.
- * @param ellipsis The string to append when truncated (default: '...').
- * @returns The truncated string.
+ * @param str - The string to truncate
+ * @param maxLength - The maximum length before truncation
+ * @param ellipsis - The string to append when truncated (default: '...')
+ * @returns The truncated string
+ *
+ * @example
+ * ```typescript
+ * TruncateString('Hello World', 5); // 'Hello...'
+ * TruncateString('Hello World', 5, '!'); // 'Hello!'
+ * ```
  */
 export declare function TruncateString(str: string, maxLength: number, ellipsis?: string): string;
 /**
  * Pads a string to a specified length.
  *
- * @param str The input string.
- * @param length The target length.
- * @param char The character to pad with (default: ' ').
- * @param padEnd If true, pads the end; otherwise, pads the start (default: true).
- * @returns The padded string.
+ * @param str - The input string
+ * @param length - The target length
+ * @param char - The character to pad with (default: ' ')
+ * @param padEnd - If true, pads the end; otherwise, pads the start (default: true)
+ * @returns The padded string
+ *
+ * @example
+ * ```typescript
+ * PadString('hello', 10); // 'hello     '
+ * PadString('hello', 10, '*'); // 'hello*****'
+ * PadString('hello', 10, '*', false); // '*****hello'
+ * ```
  */
 export declare function PadString(str: string, length: number, char?: string, padEnd?: boolean): string;
 /**
  * Removes all HTML tags from a string.
  *
- * @param str The input string.
- * @returns The string with all HTML tags stripped.
+ * @param str - The input string
+ * @returns The string with all HTML tags stripped
  *
  * @example
  * ```typescript
@@ -71,10 +84,10 @@ export declare function StripHTML(str: string): string;
 /**
  * Returns the plural form of a word based on a count.
  *
- * @param word The singular word.
- * @param count The count to test against.
- * @param plural Optional custom plural form (defaults to `word + 's'`).
- * @returns The singular word when `count === 1`, otherwise the plural.
+ * @param word - The singular word
+ * @param count - The count to test against
+ * @param plural - Optional custom plural form (defaults to `word + 's'`)
+ * @returns The singular word when `count === 1`, otherwise the plural
  *
  * @example
  * ```typescript
@@ -88,8 +101,8 @@ export declare function Pluralize(word: string, count: number, plural?: string):
  * Counts the number of words in a string.
  * Words are separated by one or more whitespace characters.
  *
- * @param str The input string.
- * @returns The number of words.
+ * @param str - The input string
+ * @returns The number of words
  *
  * @example
  * ```typescript
@@ -101,9 +114,9 @@ export declare function WordCount(str: string): number;
 /**
  * Counts the number of non-overlapping occurrences of `substr` in `str`.
  *
- * @param str The string to search in.
- * @param substr The substring to count.
- * @returns The number of occurrences.
+ * @param str - The string to search in
+ * @param substr - The substring to count
+ * @returns The number of occurrences
  *
  * @example
  * ```typescript

package/dist/string/formatting.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"formatting.d.ts","sourceRoot":"","sources":["../../src/string/formatting.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAM7D;;;;;;;;;;;;GAYG;AACH,wBAAgB,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAW9C;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAgB,YAAY,CAC3B,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,aAAa,GAAG,WAAW,GACjC,MAAM,CAoBR;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,cAAc,CAAC,GAAG,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,SAAQ,GAAG,MAAM,CAUvF;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,SAAM,EAAE,MAAM,UAAO,GAAG,MAAM,CASxF;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAG7C;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,CAG9E;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAG7C;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,CASpE"}

package/{build → dist}/string/formatting.js

@@ -1,3 +1,6 @@
+// Unicode flag (u) ensures consistent behavior with multi-byte characters (emoji, combining marks).
+const INDEX_PLACEHOLDER_REGEX = /\{(\d+)\}/gu;
+const KEY_PLACEHOLDER_REGEX = /\{(\w+)\}/gu;
 /**
  * Escapes a string for safe use in HTML by replacing special characters with
  * their HTML entity equivalents.
@@ -23,8 +26,8 @@ export function EscapeHTML(str) {
     return '';
 }
 /**
- * Formats a string by replacing placeholders with values
- * Supports both named placeholders {name} and positional {0}, {1}
+ * Formats a string by replacing placeholders with values.
+ * Supports both named placeholders {name} and positional {0}, {1}.
  *
  * @param template - The template string with placeholders
  * @param params - Either an object with named parameters or array of positional parameters
@@ -49,12 +52,12 @@ export function FormatString(template, params) {
     if (template && typeof template === 'string') {
         if (params && (Array.isArray(params) || typeof params === 'object')) {
             if (Array.isArray(params)) {
-                return template.replace(/{(\d+)}/g, (match, index) => {
+                return template.replace(INDEX_PLACEHOLDER_REGEX, (match, index) => {
                     const value = params[parseInt(index, 10)];
                     return value !== undefined && value !== null ? String(value) : match;
                 });
             }
-            return template.replace(/{(\w+)}/g, (match, key) => {
+            return template.replace(KEY_PLACEHOLDER_REGEX, (match, key) => {
                 const value = params[key];
                 return value !== undefined && value !== null ? String(value) : match;
             });
@@ -66,10 +69,16 @@ export function FormatString(template, params) {
 /**
  * Truncates a string to a specified length, appending an ellipsis if truncated.
  *
- * @param str The string to truncate.
- * @param maxLength The maximum length before truncation.
- * @param ellipsis The string to append when truncated (default: '...').
- * @returns The truncated string.
+ * @param str - The string to truncate
+ * @param maxLength - The maximum length before truncation
+ * @param ellipsis - The string to append when truncated (default: '...')
+ * @returns The truncated string
+ *
+ * @example
+ * ```typescript
+ * TruncateString('Hello World', 5); // 'Hello...'
+ * TruncateString('Hello World', 5, '!'); // 'Hello!'
+ * ```
  */
 export function TruncateString(str, maxLength, ellipsis = '...') {
     if (str && typeof str === 'string' && maxLength > 0) {
@@ -83,11 +92,18 @@ export function TruncateString(str, maxLength, ellipsis = '...') {
 /**
  * Pads a string to a specified length.
  *
- * @param str The input string.
- * @param length The target length.
- * @param char The character to pad with (default: ' ').
- * @param padEnd If true, pads the end; otherwise, pads the start (default: true).
- * @returns The padded string.
+ * @param str - The input string
+ * @param length - The target length
+ * @param char - The character to pad with (default: ' ')
+ * @param padEnd - If true, pads the end; otherwise, pads the start (default: true)
+ * @returns The padded string
+ *
+ * @example
+ * ```typescript
+ * PadString('hello', 10); // 'hello     '
+ * PadString('hello', 10, '*'); // 'hello*****'
+ * PadString('hello', 10, '*', false); // '*****hello'
+ * ```
  */
 export function PadString(str, length, char = ' ', padEnd = true) {
     if (typeof str === 'string' && length > str.length) {
@@ -100,8 +116,8 @@ export function PadString(str, length, char = ' ', padEnd = true) {
 /**
  * Removes all HTML tags from a string.
  *
- * @param str The input string.
- * @returns The string with all HTML tags stripped.
+ * @param str - The input string
+ * @returns The string with all HTML tags stripped
  *
  * @example
  * ```typescript
@@ -116,10 +132,10 @@ export function StripHTML(str) {
 /**
  * Returns the plural form of a word based on a count.
  *
- * @param word The singular word.
- * @param count The count to test against.
- * @param plural Optional custom plural form (defaults to `word + 's'`).
- * @returns The singular word when `count === 1`, otherwise the plural.
+ * @param word - The singular word
+ * @param count - The count to test against
+ * @param plural - Optional custom plural form (defaults to `word + 's'`)
+ * @returns The singular word when `count === 1`, otherwise the plural
  *
  * @example
  * ```typescript
@@ -137,8 +153,8 @@ export function Pluralize(word, count, plural) {
  * Counts the number of words in a string.
  * Words are separated by one or more whitespace characters.
  *
- * @param str The input string.
- * @returns The number of words.
+ * @param str - The input string
+ * @returns The number of words
  *
  * @example
  * ```typescript
@@ -154,9 +170,9 @@ export function WordCount(str) {
 /**
  * Counts the number of non-overlapping occurrences of `substr` in `str`.
  *
- * @param str The string to search in.
- * @param substr The substring to count.
- * @returns The number of occurrences.
+ * @param str - The string to search in
+ * @param substr - The substring to count
+ * @returns The number of occurrences
  *
  * @example
  * ```typescript
@@ -175,4 +191,3 @@ export function CountOccurrences(str, substr) {
     }
     return count;
 }
-//# sourceMappingURL=formatting.js.map

package/{build → dist}/string/index.d.ts

@@ -11,6 +11,7 @@ export * from './case-conversion.js';
 export * from './validation.js';
 export * from './formatting.js';
 export * from './transformation.js';
+export * from './comparison.js';
 export type { TStringValidator, TStringFormatter, TStringTransformer, TCaseConverter, TStringPredicate, TFormatValue, TFormatParams, TFormatArgs } from './types.js';
 export * from './assert.js';
 //# sourceMappingURL=index.d.ts.map

package/{build → dist}/string/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/string/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,cAAc,sBAAsB,CAAC;AACrC,cAAc,iBAAiB,CAAC;AAChC,cAAc,iBAAiB,CAAC;AAChC,cAAc,qBAAqB,CAAC;AAEpC,YAAY,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,cAAc,EAAE,gBAAgB,EAAE,YAAY,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AACrK,cAAc,aAAa,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/string/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,cAAc,sBAAsB,CAAC;AACrC,cAAc,iBAAiB,CAAC;AAChC,cAAc,iBAAiB,CAAC;AAChC,cAAc,qBAAqB,CAAC;AACpC,cAAc,iBAAiB,CAAC;AAEhC,YAAY,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,cAAc,EAAE,gBAAgB,EAAE,YAAY,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AACrK,cAAc,aAAa,CAAC"}

package/{build → dist}/string/index.js

@@ -11,5 +11,5 @@ export * from './case-conversion.js';
 export * from './validation.js';
 export * from './formatting.js';
 export * from './transformation.js';
+export * from './comparison.js';
 export * from './assert.js';
-//# sourceMappingURL=index.js.map

package/dist/string/transformation.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Reverses a string.
+ *
+ * @param input - The input string
+ * @returns The reversed string
+ *
+ * @example
+ * ```typescript
+ * ReverseString('hello'); // 'olleh'
+ * ReverseString('12345'); // '54321'
+ * ```
+ */
+export declare function ReverseString(input: string): string;
+/**
+ * Converts a string to a URL-friendly slug.
+ *
+ * @param input - The input string
+ * @returns The URL-friendly slug
+ *
+ * @example
+ * ```typescript
+ * Slugify('Hello World!'); // 'hello-world'
+ * Slugify('The Quick Brown Fox'); // 'the-quick-brown-fox'
+ * Slugify('CamelCaseText'); // 'camelcasetext'
+ * ```
+ */
+export declare function Slugify(input: string): string;
+//# sourceMappingURL=transformation.d.ts.map

package/dist/string/transformation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"transformation.d.ts","sourceRoot":"","sources":["../../src/string/transformation.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAMnD;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAW7C"}