add tye

Author: Zheruel

CHANGELOG.md

@@ -7,6 +7,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.6.0] - 2025-09-06
+
+### Added
+
+- **TypeScript Function Overloads** for improved type inference
+  - Added overload signatures to 13 functions with optional parameters
+  - Better IDE autocomplete and parameter hints
+  - More precise return type inference based on arguments
+  - Functions with overloads: `truncate`, `pad`, `padStart`, `padEnd`, `template`, `templateSafe`, `excerpt`, `highlight`, `fuzzyMatch`, `memoize`, `randomString`, `toASCII`, `removeNonPrintable`
+  - No breaking changes - fully backward compatible
+
 ## [0.5.2] - 2025-09-06
 
 ### Added

README.md

@@ -14,11 +14,11 @@ Ultra-lightweight string utilities with zero dependencies. Tree-shakeable, fully
 - 🚀 **Zero dependencies** - No bloat, just pure functions
 - 📦 **< 1KB per function** - Minimal bundle impact
 - 🌳 **Tree-shakeable** - Only import what you need
-- 💪 **Fully typed** - Complete TypeScript support
+- 💪 **Fully typed** - Complete TypeScript support with function overloads
 - ⚡ **Fast performance** - 2-25x faster than lodash for many operations
 - ⚡ **ESM & CJS** - Works everywhere
 - 🧪 **100% tested** - Reliable and production-ready
-- 🔒 **Type-safe** - Written in strict TypeScript
+- 🔒 **Type-safe** - Written in strict TypeScript with enhanced type inference
 - 📝 **Well documented** - JSDoc comments for all functions
 
 ## Installation

jsr.json

@@ -1,6 +1,6 @@
 {
   "name": "@zheruel/nano-string-utils",
-  "version": "0.5.2",
+  "version": "0.6.0",
   "exports": "./src/index.ts",
   "publish": {
     "include": ["src/**/*.ts", "README.md", "LICENSE", "CHANGELOG.md"],

package.json

@@ -1,6 +1,6 @@
 {
   "name": "nano-string-utils",
-  "version": "0.5.2",
+  "version": "0.6.0",
   "description": "Ultra-lightweight string utilities with zero dependencies",
   "type": "module",
   "main": "./dist/index.cjs",

src/excerpt.ts

@@ -11,6 +11,8 @@ const TRAILING_PUNCT = /[,;:\-–—]+$/;
  * excerpt('The quick brown fox jumps over the lazy dog', 20) // 'The quick brown fox...'
  * excerpt('Hello world. This is a test.', 15) // 'Hello world...'
  */
+export function excerpt(text: string, length: number): string;
+export function excerpt(text: string, length: number, suffix: string): string;
 export function excerpt(text: string, length: number, suffix = "..."): string {
   if (!text || text.length <= length) {
     return text;

src/fuzzyMatch.ts

@@ -46,6 +46,15 @@ export interface FuzzyMatchResult {
  * // { matched: false, score: 0 }
  * ```
  */
+export function fuzzyMatch(
+  query: string,
+  target: string
+): FuzzyMatchResult | null;
+export function fuzzyMatch(
+  query: string,
+  target: string,
+  options: FuzzyMatchOptions
+): FuzzyMatchResult | null;
 export function fuzzyMatch(
   query: string,
   target: string,

src/highlight.ts

@@ -19,6 +19,18 @@ export interface HighlightOptions {
  * highlight("Error: Connection failed", ["error", "failed"], { wrapper: ['**', '**'] })
  * // => "**Error**: Connection **failed**"
  */
+export function highlight(text: string, terms: string): string;
+export function highlight(text: string, terms: string[]): string;
+export function highlight(
+  text: string,
+  terms: string,
+  options: HighlightOptions
+): string;
+export function highlight(
+  text: string,
+  terms: string[],
+  options: HighlightOptions
+): string;
 export function highlight(
   text: string,
   terms: string | string[],

src/memoize.ts

@@ -55,6 +55,11 @@ export interface MemoizeOptions {
  * });
  * ```
  */
+export function memoize<T extends (...args: any[]) => any>(fn: T): T;
+export function memoize<T extends (...args: any[]) => any>(
+  fn: T,
+  options: MemoizeOptions
+): T;
 export function memoize<T extends (...args: any[]) => any>(
   fn: T,
   options: MemoizeOptions = {}

src/pad.ts

@@ -9,6 +9,8 @@
  * pad('Hi', 6, '-') // '--Hi--'
  * pad('Hi', 7, '-') // '--Hi---'
  */
+export function pad(str: string, length: number): string;
+export function pad(str: string, length: number, chars: string): string;
 export function pad(str: string, length: number, chars = " "): string {
   // Quick check for Unicode (emoji, combining chars, etc)
   const hasUnicode =

src/padEnd.ts

@@ -9,6 +9,8 @@
  * padEnd('Hi', 6, '=-') // 'Hi=-=-'
  * padEnd('5', 3, '0') // '500'
  */
+export function padEnd(str: string, length: number): string;
+export function padEnd(str: string, length: number, chars: string): string;
 export function padEnd(str: string, length: number, chars = " "): string {
   const strLen = Array.from(str).length;