@pawells/typescript-common 1.4.1 → 2.0.0

package/build/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/build/string/formatting.d.ts.map

@@ -1 +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;AAE7D;;;;;;;;;;;;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;;;;;;;GAOG;AACH,wBAAgB,cAAc,CAAC,GAAG,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,SAAQ,GAAG,MAAM,CAUvF;AAED;;;;;;;;GAQG;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"}
+{"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;AAE7D;;;;;;;;;;;;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/string/formatting.js

@@ -23,8 +23,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
@@ -66,10 +66,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 +89,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 +113,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 +129,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 +150,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 +167,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

package/build/string/formatting.js.map

@@ -1 +1 @@
-{"version":3,"file":"formatting.js","sourceRoot":"","sources":["../../src/string/formatting.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,UAAU,CAAC,GAAW;IACrC,IAAI,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;QACpC,OAAO,GAAG;aACR,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC;aACvB,OAAO,CAAC,KAAK,EAAE,MAAM,CAAC;aACtB,OAAO,CAAC,KAAK,EAAE,MAAM,CAAC;aACtB,OAAO,CAAC,KAAK,EAAE,QAAQ,CAAC;aACxB,OAAO,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IAC5B,CAAC;IAED,OAAO,EAAE,CAAC;AACX,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,UAAU,YAAY,CAC3B,QAAgB,EAChB,MAAmC;IAEnC,IAAI,QAAQ,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;QAC9C,IAAI,MAAM,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,OAAO,MAAM,KAAK,QAAQ,CAAC,EAAE,CAAC;YACrE,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;gBAC3B,OAAO,QAAQ,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;oBACpD,MAAM,KAAK,GAAG,MAAM,CAAC,QAAQ,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC;oBAC1C,OAAO,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;gBACtE,CAAC,CAAC,CAAC;YACJ,CAAC;YAED,OAAO,QAAQ,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;gBAClD,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;gBAC1B,OAAO,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;YACtE,CAAC,CAAC,CAAC;QACJ,CAAC;QAED,OAAO,QAAQ,CAAC;IACjB,CAAC;IAED,OAAO,EAAE,CAAC;AACX,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,cAAc,CAAC,GAAW,EAAE,SAAiB,EAAE,QAAQ,GAAG,KAAK;IAC9E,IAAI,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,SAAS,GAAG,CAAC,EAAE,CAAC;QACrD,IAAI,GAAG,CAAC,MAAM,IAAI,SAAS,EAAE,CAAC;YAC7B,OAAO,GAAG,CAAC;QACZ,CAAC;QAED,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,SAAS,CAAC,GAAG,QAAQ,CAAC;IAC3C,CAAC;IAED,OAAO,EAAE,CAAC;AACX,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,SAAS,CAAC,GAAW,EAAE,MAAc,EAAE,IAAI,GAAG,GAAG,EAAE,MAAM,GAAG,IAAI;IAC/E,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,MAAM,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC;QACpD,MAAM,aAAa,GAAG,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC;QAC1C,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QAE3C,OAAO,MAAM,CAAC,CAAC,CAAC,GAAG,GAAG,OAAO,CAAC,CAAC,CAAC,OAAO,GAAG,GAAG,CAAC;IAC/C,CAAC;IAED,OAAO,GAAG,IAAI,EAAE,CAAC;AAClB,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,SAAS,CAAC,GAAW;IACpC,IAAI,CAAC,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ;QAAE,OAAO,EAAE,CAAC;IAC/C,OAAO,GAAG,CAAC,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;AACrC,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,SAAS,CAAC,IAAY,EAAE,KAAa,EAAE,MAAe;IACrE,IAAI,CAAC,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ;QAAE,OAAO,EAAE,CAAC;IACjD,OAAO,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,CAAC;AACpD,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,SAAS,CAAC,GAAW;IACpC,IAAI,CAAC,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ;QAAE,OAAO,CAAC,CAAC;IAC9C,OAAO,GAAG,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC;AACxD,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,gBAAgB,CAAC,GAAW,EAAE,MAAc;IAC3D,IAAI,CAAC,GAAG,IAAI,CAAC,MAAM;QAAE,OAAO,CAAC,CAAC;IAC9B,IAAI,KAAK,GAAG,CAAC,CAAC;IACd,IAAI,GAAG,GAAG,CAAC,CAAC;IACZ,OAAO,CAAC,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;QAChD,KAAK,EAAE,CAAC;QACR,GAAG,IAAI,MAAM,CAAC,MAAM,CAAC;IACtB,CAAC;IACD,OAAO,KAAK,CAAC;AACd,CAAC"}
+{"version":3,"file":"formatting.js","sourceRoot":"","sources":["../../src/string/formatting.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,UAAU,CAAC,GAAW;IACrC,IAAI,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;QACpC,OAAO,GAAG;aACR,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC;aACvB,OAAO,CAAC,KAAK,EAAE,MAAM,CAAC;aACtB,OAAO,CAAC,KAAK,EAAE,MAAM,CAAC;aACtB,OAAO,CAAC,KAAK,EAAE,QAAQ,CAAC;aACxB,OAAO,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IAC5B,CAAC;IAED,OAAO,EAAE,CAAC;AACX,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,UAAU,YAAY,CAC3B,QAAgB,EAChB,MAAmC;IAEnC,IAAI,QAAQ,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;QAC9C,IAAI,MAAM,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,OAAO,MAAM,KAAK,QAAQ,CAAC,EAAE,CAAC;YACrE,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;gBAC3B,OAAO,QAAQ,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;oBACpD,MAAM,KAAK,GAAG,MAAM,CAAC,QAAQ,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC;oBAC1C,OAAO,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;gBACtE,CAAC,CAAC,CAAC;YACJ,CAAC;YAED,OAAO,QAAQ,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;gBAClD,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;gBAC1B,OAAO,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;YACtE,CAAC,CAAC,CAAC;QACJ,CAAC;QAED,OAAO,QAAQ,CAAC;IACjB,CAAC;IAED,OAAO,EAAE,CAAC;AACX,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,cAAc,CAAC,GAAW,EAAE,SAAiB,EAAE,QAAQ,GAAG,KAAK;IAC9E,IAAI,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,SAAS,GAAG,CAAC,EAAE,CAAC;QACrD,IAAI,GAAG,CAAC,MAAM,IAAI,SAAS,EAAE,CAAC;YAC7B,OAAO,GAAG,CAAC;QACZ,CAAC;QAED,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,SAAS,CAAC,GAAG,QAAQ,CAAC;IAC3C,CAAC;IAED,OAAO,EAAE,CAAC;AACX,CAAC;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAM,UAAU,SAAS,CAAC,GAAW,EAAE,MAAc,EAAE,IAAI,GAAG,GAAG,EAAE,MAAM,GAAG,IAAI;IAC/E,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,MAAM,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC;QACpD,MAAM,aAAa,GAAG,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC;QAC1C,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QAE3C,OAAO,MAAM,CAAC,CAAC,CAAC,GAAG,GAAG,OAAO,CAAC,CAAC,CAAC,OAAO,GAAG,GAAG,CAAC;IAC/C,CAAC;IAED,OAAO,GAAG,IAAI,EAAE,CAAC;AAClB,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,SAAS,CAAC,GAAW;IACpC,IAAI,CAAC,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ;QAAE,OAAO,EAAE,CAAC;IAC/C,OAAO,GAAG,CAAC,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;AACrC,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,SAAS,CAAC,IAAY,EAAE,KAAa,EAAE,MAAe;IACrE,IAAI,CAAC,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ;QAAE,OAAO,EAAE,CAAC;IACjD,OAAO,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,CAAC;AACpD,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,SAAS,CAAC,GAAW;IACpC,IAAI,CAAC,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ;QAAE,OAAO,CAAC,CAAC;IAC9C,OAAO,GAAG,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC;AACxD,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,gBAAgB,CAAC,GAAW,EAAE,MAAc;IAC3D,IAAI,CAAC,GAAG,IAAI,CAAC,MAAM;QAAE,OAAO,CAAC,CAAC;IAC9B,IAAI,KAAK,GAAG,CAAC,CAAC;IACd,IAAI,GAAG,GAAG,CAAC,CAAC;IACZ,OAAO,CAAC,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;QAChD,KAAK,EAAE,CAAC;QACR,GAAG,IAAI,MAAM,CAAC,MAAM,CAAC;IACtB,CAAC;IACD,OAAO,KAAK,CAAC;AACd,CAAC"}

package/build/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/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/string/index.js

@@ -11,5 +11,6 @@ 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/build/string/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","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;AAGpC,cAAc,aAAa,CAAC"}
+{"version":3,"file":"index.js","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;AAGhC,cAAc,aAAa,CAAC"}

package/build/string/transformation.d.ts

@@ -1,18 +1,28 @@
-import type { TStringTransformer } from './types.js';
 /**
  * Reverses a string.
  *
- * @param input The input string.
- * @returns The reversed string.
- * @see {@link TStringTransformer}
+ * @param input - The input string
+ * @returns The reversed string
+ *
+ * @example
+ * ```typescript
+ * ReverseString('hello'); // 'olleh'
+ * ReverseString('12345'); // '54321'
+ * ```
  */
-export declare const REVERSE_STRING: TStringTransformer;
+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.
- * @see {@link TStringTransformer}
+ * @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 const SLUGIFY: TStringTransformer;
+export declare function Slugify(input: string): string;
 //# sourceMappingURL=transformation.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"transformation.d.ts","sourceRoot":"","sources":["../../src/string/transformation.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC;AAErD;;;;;;GAMG;AACH,eAAO,MAAM,cAAc,EAAE,kBAM5B,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,OAAO,EAAE,kBAWrB,CAAC"}
+{"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"}

package/build/string/transformation.js

@@ -1,24 +1,35 @@
 /**
  * Reverses a string.
  *
- * @param input The input string.
- * @returns The reversed string.
- * @see {@link TStringTransformer}
+ * @param input - The input string
+ * @returns The reversed string
+ *
+ * @example
+ * ```typescript
+ * ReverseString('hello'); // 'olleh'
+ * ReverseString('12345'); // '54321'
+ * ```
  */
-export const REVERSE_STRING = (input) => {
+export function ReverseString(input) {
     if (input && typeof input === 'string') {
         return Array.from(input).reverse().join('');
     }
     return '';
-};
+}
 /**
  * Converts a string to a URL-friendly slug.
  *
- * @param input The input string.
- * @returns The URL-friendly slug.
- * @see {@link TStringTransformer}
+ * @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 const SLUGIFY = (input) => {
+export function Slugify(input) {
     if (input && typeof input === 'string') {
         return input
             .toLowerCase()
@@ -28,5 +39,5 @@ export const SLUGIFY = (input) => {
             .replace(/^-+|-+$/gu, '');
     }
     return '';
-};
+}
 //# sourceMappingURL=transformation.js.map

package/build/string/transformation.js.map

@@ -1 +1 @@
-{"version":3,"file":"transformation.js","sourceRoot":"","sources":["../../src/string/transformation.ts"],"names":[],"mappings":"AAEA;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,cAAc,GAAuB,CAAC,KAAa,EAAU,EAAE;IAC3E,IAAI,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QACxC,OAAO,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAC7C,CAAC;IAED,OAAO,EAAE,CAAC;AACX,CAAC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,OAAO,GAAuB,CAAC,KAAa,EAAU,EAAE;IACpE,IAAI,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QACxC,OAAO,KAAK;aACV,WAAW,EAAE;aACb,IAAI,EAAE;aACN,OAAO,CAAC,YAAY,EAAE,EAAE,CAAC;aACzB,OAAO,CAAC,WAAW,EAAE,GAAG,CAAC;aACzB,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;IAC5B,CAAC;IAED,OAAO,EAAE,CAAC;AACX,CAAC,CAAC"}
+{"version":3,"file":"transformation.js","sourceRoot":"","sources":["../../src/string/transformation.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,aAAa,CAAC,KAAa;IAC1C,IAAI,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QACxC,OAAO,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAC7C,CAAC;IAED,OAAO,EAAE,CAAC;AACX,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,OAAO,CAAC,KAAa;IACpC,IAAI,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QACxC,OAAO,KAAK;aACV,WAAW,EAAE;aACb,IAAI,EAAE;aACN,OAAO,CAAC,YAAY,EAAE,EAAE,CAAC;aACzB,OAAO,CAAC,WAAW,EAAE,GAAG,CAAC;aACzB,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;IAC5B,CAAC;IAED,OAAO,EAAE,CAAC;AACX,CAAC"}

package/build/string/validation.d.ts

@@ -1,18 +1,30 @@
-import type { TStringValidator } from './types.js';
 /**
  * Checks if a string is empty or contains only whitespace.
  *
- * @param value The string to check.
- * @returns `true` if the string is empty or contains only whitespace.
- * @see {@link TStringValidator}
+ * @param value - The string to check
+ * @returns `true` if the string is empty or contains only whitespace
+ *
+ * @example
+ * ```typescript
+ * IsBlankString(''); // true
+ * IsBlankString('   '); // true
+ * IsBlankString('hello'); // false
+ * ```
  */
-export declare const IS_BLANK_STRING: TStringValidator;
+export declare function IsBlankString(value: string): boolean;
 /**
  * Checks if a string is a valid hexadecimal value.
  *
- * @param value The input string.
- * @returns `true` if the string is a valid hexadecimal value.
- * @see {@link TStringValidator}
+ * @param value - The input string
+ * @returns `true` if the string is a valid hexadecimal value
+ *
+ * @example
+ * ```typescript
+ * IsHexString('#ff00ff'); // true
+ * IsHexString('0xDEADBEEF'); // true
+ * IsHexString('ff00ff'); // true
+ * IsHexString('xyz'); // false
+ * ```
  */
-export declare const IS_HEX_STRING: TStringValidator;
+export declare function IsHexString(value: string): boolean;
 //# sourceMappingURL=validation.d.ts.map

package/build/string/validation.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"validation.d.ts","sourceRoot":"","sources":["../../src/string/validation.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAEnD;;;;;;GAMG;AACH,eAAO,MAAM,eAAe,EAAE,gBAE7B,CAAC;AAQF;;;;;;GAMG;AACH,eAAO,MAAM,aAAa,EAAE,gBAE3B,CAAC"}
+{"version":3,"file":"validation.d.ts","sourceRoot":"","sources":["../../src/string/validation.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAEpD;AAQD;;;;;;;;;;;;;GAaG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAElD"}

package/build/string/validation.js

@@ -1,13 +1,19 @@
 /**
  * Checks if a string is empty or contains only whitespace.
  *
- * @param value The string to check.
- * @returns `true` if the string is empty or contains only whitespace.
- * @see {@link TStringValidator}
+ * @param value - The string to check
+ * @returns `true` if the string is empty or contains only whitespace
+ *
+ * @example
+ * ```typescript
+ * IsBlankString(''); // true
+ * IsBlankString('   '); // true
+ * IsBlankString('hello'); // false
+ * ```
  */
-export const IS_BLANK_STRING = (value) => {
+export function IsBlankString(value) {
     return !value || (/^\s*$/u).test(value);
-};
+}
 /**
  * Compiled regex pattern for hexadecimal validation.
  * Cached for optimal performance with repeated calls.
@@ -16,11 +22,18 @@ const HEX_PATTERN = /^(?<prefix>#|0x)?(?<hex>[0-9a-f]+)$/iu;
 /**
  * Checks if a string is a valid hexadecimal value.
  *
- * @param value The input string.
- * @returns `true` if the string is a valid hexadecimal value.
- * @see {@link TStringValidator}
+ * @param value - The input string
+ * @returns `true` if the string is a valid hexadecimal value
+ *
+ * @example
+ * ```typescript
+ * IsHexString('#ff00ff'); // true
+ * IsHexString('0xDEADBEEF'); // true
+ * IsHexString('ff00ff'); // true
+ * IsHexString('xyz'); // false
+ * ```
  */
-export const IS_HEX_STRING = (value) => {
+export function IsHexString(value) {
     return HEX_PATTERN.test(value);
-};
+}
 //# sourceMappingURL=validation.js.map

package/build/string/validation.js.map

@@ -1 +1 @@
-{"version":3,"file":"validation.js","sourceRoot":"","sources":["../../src/string/validation.ts"],"names":[],"mappings":"AAEA;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,eAAe,GAAqB,CAAC,KAAa,EAAW,EAAE;IAC3E,OAAO,CAAC,KAAK,IAAI,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;AACzC,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,WAAW,GAAG,uCAAuC,CAAC;AAE5D;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,aAAa,GAAqB,CAAC,KAAa,EAAW,EAAE;IACzE,OAAO,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;AAChC,CAAC,CAAC"}
+{"version":3,"file":"validation.js","sourceRoot":"","sources":["../../src/string/validation.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,aAAa,CAAC,KAAa;IAC1C,OAAO,CAAC,KAAK,IAAI,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;AACzC,CAAC;AAED;;;GAGG;AACH,MAAM,WAAW,GAAG,uCAAuC,CAAC;AAE5D;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,WAAW,CAAC,KAAa;IACxC,OAAO,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;AAChC,CAAC"}

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@pawells/typescript-common",
 	"displayName": "TypeScript Common Utilities",
-	"version": "1.4.1",
+	"version": "2.0.0",
 	"description": "Shared TypeScript utility library — array, object, string, time, and enum helpers. ESM-only, no runtime dependencies.",
 	"type": "module",
 	"main": "./build/index.js",
@@ -41,7 +41,7 @@
 		"eslint-plugin-unused-imports": "^4.0.0",
 		"globals": "^17.4.0",
 		"husky": "^9.1.7",
-		"typescript": "^5.3.3",
+		"typescript": "^6.0.2",
 		"vitest": "^4.0.18"
 	},
 	"keywords": [