@sohanemon/utils 6.3.8 → 6.4.0

package/dist/{index-BZaFEd2-.d.ts → index-CKE8ocfo.d.ts}

@@ -2,9 +2,61 @@ import { ClassValue } from "clsx";
 import * as React from "react";
 
 //#region src/functions/cookie.d.ts
+
+/**
+ * Sets a client-side cookie with optional expiration and path.
+ *
+ * @param name - The name of the cookie
+ * @param value - The value to store in the cookie
+ * @param days - Optional number of days until the cookie expires
+ * @param path - Optional path for the cookie (defaults to '/')
+ *
+ * @example
+ * // Set a cookie that expires in 7 days
+ * setClientSideCookie('userId', '12345', 7);
+ *
+ * @example
+ * // Set a session cookie (no expiration)
+ * setClientSideCookie('sessionId', 'abc123');
+ */
 declare const setClientSideCookie: (name: string, value: string, days?: number, path?: string) => void;
+/**
+ * Deletes a client-side cookie by setting its expiration to a past date.
+ *
+ * @param name - The name of the cookie to delete
+ * @param path - Optional path for the cookie (defaults to '/')
+ *
+ * @example
+ * // Delete a cookie
+ * deleteClientSideCookie('userId');
+ */
 declare const deleteClientSideCookie: (name: string, path?: string) => void;
+/**
+ * Checks if a client-side cookie exists.
+ *
+ * @param name - The name of the cookie to check
+ * @returns True if the cookie exists, false otherwise
+ *
+ * @example
+ * // Check if a cookie exists
+ * if (hasClientSideCookie('userId')) {
+ *   console.log('User is logged in');
+ * }
+ */
 declare const hasClientSideCookie: (name: string) => boolean;
+/**
+ * Retrieves the value of a client-side cookie.
+ *
+ * @param name - The name of the cookie to retrieve
+ * @returns An object containing the cookie value, or undefined if not found
+ *
+ * @example
+ * // Get a cookie value
+ * const { value } = getClientSideCookie('userId');
+ * if (value) {
+ *   console.log('User ID:', value);
+ * }
+ */
 declare const getClientSideCookie: (name: string) => {
   value: string | undefined;
 };
@@ -40,20 +92,52 @@ type TMerged<T> = [T] extends [Array<any>] ? { [K in keyof T]: TMerged<T[K]> } :
  * @returns The merged object with proper typing
  *
  * @example
- * // Basic merge
+ * // Basic shallow merge
  * deepmerge({ a: 1 }, { b: 2 }) // { a: 1, b: 2 }
  *
  * @example
- * // Nested merge
- * deepmerge({ a: { x: 1 } }, { a: { y: 2 } }) // { a: { x: 1, y: 2 } }
+ * // Deep merge of nested objects
+ * deepmerge({ user: { name: 'John' } }, { user: { age: 30 } })
+ * // { user: { name: 'John', age: 30 } }
+ *
+ * @example
+ * // Array concatenation
+ * deepmerge({ tags: ['react'] }, { tags: ['typescript'] }, { arrayMerge: 'concat' })
+ * // { tags: ['react', 'typescript'] }
  *
  * @example
- * // Array concat
- * deepmerge({ arr: [1] }, { arr: [2] }, { arrayMerge: 'concat' }) // { arr: [1, 2] }
+ * // Array replacement (default)
+ * deepmerge({ items: [1, 2] }, { items: [3, 4] })
+ * // { items: [3, 4] }
  *
  * @example
- * // Sources with extra properties
- * deepmerge({ a: 1 }, { b: 2, c: 3 }) // { a: 1, b: 2, c: 3 }
+ * // Custom array merging
+ * deepmerge(
+ *   { scores: [85, 90] },
+ *   { scores: [95] },
+ *   { arrayMerge: (target, source) => [...target, ...source] }
+ * )
+ * // { scores: [85, 90, 95] }
+ *
+ * @example
+ * // Configuration merging
+ * const defaultConfig = { theme: 'light', features: { darkMode: false } };
+ * const userConfig = { theme: 'dark', features: { darkMode: true, animations: true } };
+ * deepmerge(defaultConfig, userConfig);
+ * // { theme: 'dark', features: { darkMode: true, animations: true } }
+ *
+ * @example
+ * // State updates in reducers
+ * const initialState = { user: { profile: { name: '' } }, settings: {} };
+ * const action = { user: { profile: { name: 'Alice' } }, settings: { theme: 'dark' } };
+ * const newState = deepmerge(initialState, action);
+ *
+ * @example
+ * // Merging API responses
+ * const cachedData = { posts: [{ id: 1, title: 'Old' }] };
+ * const freshData = { posts: [{ id: 1, title: 'Updated', author: 'Bob' }] };
+ * deepmerge(cachedData, freshData);
+ * // { posts: [{ id: 1, title: 'Updated', author: 'Bob' }] }
  */
 declare function deepmerge<T extends Record<string, any>, S extends Record<string, any>[]>(target: T, ...sources: S): TMerged<T | S[number]>;
 declare function deepmerge<T extends Record<string, any>, S extends Record<string, any>[]>(target: T, sources: S, options?: {
@@ -72,8 +156,42 @@ type Hydrate<T> = T extends null ? undefined : T extends (infer U)[] ? Hydrate<U
  * @returns Same type as input, but with all nulls replaced by undefined
  *
  * @example
- * hydrate({ a: null, b: 'test' }) // { a: undefined, b: 'test' }
- * hydrate([null, 1, { c: null }]) // [undefined, 1, { c: undefined }]
+ * ```ts
+ * // Basic object hydration
+ * hydrate({ name: null, age: 25 }) // { name: undefined, age: 25 }
+ *
+ * // Nested object hydration
+ * hydrate({
+ *   user: { email: null, profile: { avatar: null } },
+ *   settings: { theme: 'dark' }
+ * })
+ * // { user: { email: undefined, profile: { avatar: undefined } }, settings: { theme: 'dark' } }
+ *
+ * // Array hydration
+ * hydrate([null, 'hello', null, 42]) // [undefined, 'hello', undefined, 42]
+ *
+ * // Mixed data structures
+ * hydrate({
+ *   posts: [null, { title: 'Hello', content: null }],
+ *   metadata: { published: null, tags: ['react', null] }
+ * })
+ * ```
+ *
+ * @example
+ * ```ts
+ * // API response normalization
+ * const apiResponse = await fetch('/api/user');
+ * const rawData = await apiResponse.json(); // May contain null values
+ * const normalizedData = hydrate(rawData); // Convert nulls to undefined
+ *
+ * // Database result processing
+ * const dbResult = query('SELECT * FROM users'); // Some fields may be NULL
+ * const cleanData = hydrate(dbResult); // Normalize for consistent handling
+ *
+ * // Form data sanitization
+ * const formData = getFormValues(); // May have null values from empty fields
+ * const sanitizedData = hydrate(formData); // Prepare for validation/state
+ * ```
  */
 declare function hydrate<T>(data: T): Hydrate<T>;
 //#endregion
@@ -157,14 +275,32 @@ declare function getObjectValue<T, S extends string>(obj: T, path: S): GetValue<
  * @returns The same object/function, augmented with the given properties
  *
  * @example
- * // Extend an object
- * const obj = extendProps({ a: 1 }, { b: "hello" });
- * // obj has { a: number; b: string }
- *
- * // Extend a function
- * const fn = (x: number) => x * 2;
- * const enhanced = extendProps(fn, { name: "doubler" });
- * // enhanced is callable and also has { name: string }
+ * ```ts
+ * // Extend a plain object
+ * const config = extendProps({ apiUrl: '/api' }, { timeout: 5000 });
+ * // config has both apiUrl and timeout properties
+ *
+ * // Extend a function with metadata
+ * const fetchData = (url: string) => fetch(url).then(r => r.json());
+ * const enhancedFetch = extendProps(fetchData, {
+ *   description: 'Data fetching utility',
+ *   version: '1.0'
+ * });
+ * // enhancedFetch is callable and has description/version properties
+ *
+ * // Create plugin system
+ * const basePlugin = { name: 'base', enabled: true };
+ * const authPlugin = extendProps(basePlugin, {
+ *   authenticate: (token: string) => validateToken(token)
+ * });
+ *
+ * // Build configuration objects
+ * const defaultSettings = { theme: 'light', lang: 'en' };
+ * const userSettings = extendProps(defaultSettings, {
+ *   theme: 'dark',
+ *   notifications: true
+ * });
+ * ```
  */
 declare function extendProps<T extends object, P$1 extends object>(base: T, props: P$1): T & P$1;
 //#endregion
@@ -195,11 +331,52 @@ declare function extendProps<T extends object, P$1 extends object>(base: T, prop
  *
  * @example
  * ```ts
+ * // Poll for job completion
  * const job = await poll(async () => {
  *   const status = await getJobStatus();
  *   return status === 'done' ? status : null;
  * }, { interval: 3000, timeout: 60000 });
  * ```
+ *
+ * @example
+ * ```ts
+ * // Wait for API endpoint to be ready
+ * const apiReady = await poll(async () => {
+ *   try {
+ *     await fetch('/api/health');
+ *     return true;
+ *   } catch {
+ *     return null;
+ *   }
+ * }, { interval: 1000, timeout: 30000 });
+ * ```
+ *
+ * @example
+ * ```ts
+ * // Poll with abort signal for cancellation
+ * const controller = new AbortController();
+ * setTimeout(() => controller.abort(), 10000); // Cancel after 10s
+ *
+ * try {
+ *   const result = await poll(
+ *     () => checkExternalService(),
+ *     { interval: 2000, signal: controller.signal }
+ *   );
+ * } catch (err) {
+ *   if (err.name === 'AbortError') {
+ *     console.log('Polling was cancelled');
+ *   }
+ * }
+ * ```
+ *
+ * @example
+ * ```ts
+ * // Poll for user action completion
+ * const userConfirmed = await poll(async () => {
+ *   const confirmations = await getPendingConfirmations();
+ *   return confirmations.length > 0 ? confirmations[0] : null;
+ * }, { interval: 5000, timeout: 300000 }); // 5 min timeout
+ * ```
  */
 declare function poll<T>(cond: () => Promise<T | null | false | undefined>, {
   interval,
@@ -214,16 +391,44 @@ declare function poll<T>(cond: () => Promise<T | null | false | undefined>, {
 }>): Promise<T>;
 //#endregion
 //#region src/functions/schedule.d.ts
+/**
+ * A task function that can be synchronous or asynchronous.
+ */
 type Task = () => Promise<void> | void;
+/**
+ * Options for configuring the schedule function.
+ */
 interface ScheduleOpts {
+  /** Number of retry attempts on failure. Defaults to 0. */
   retry?: number;
+  /** Delay in milliseconds between retries. Defaults to 0. */
   delay?: number;
+  /** Maximum time in milliseconds to wait for the task to complete. */
   timeout?: number;
 }
 /**
- * Runs a function asynchronously in the background.
- * Returns immediately, retries on failure if configured.
- * Logs total time taken.
+ * Runs a function asynchronously in the background without blocking the main thread.
+ *
+ * Executes the task immediately using setTimeout, with optional retry logic on failure.
+ * Useful for non-critical operations like analytics, logging, or background processing.
+ * Logs execution time and retry attempts to the console.
+ *
+ * @param task - The function to execute asynchronously
+ * @param options - Configuration options for retries and timing
+ *
+ * @example
+ * ```ts
+ * // Simple background task
+ * schedule(() => {
+ *   console.log('Background work done');
+ * });
+ *
+ * // Task with retry on failure
+ * schedule(
+ *   () => sendAnalytics(),
+ *   { retry: 3, delay: 1000 }
+ * );
+ * ```
  */
 declare function schedule(task: Task, options?: ScheduleOpts): void;
 //#endregion
@@ -237,11 +442,62 @@ declare function schedule(task: Task, options?: ScheduleOpts): void;
  *
  * @example
  * ```ts
- * const [err, value] = shield(() => riskySync());
- * if (err) console.error(err);
+ * // Synchronous error handling
+ * const [err, value] = shield(() => {
+ *   if (Math.random() > 0.5) throw new Error('Random failure');
+ *   return 'success';
+ * });
+ * if (err) {
+ *   console.error('Operation failed:', err);
+ * } else {
+ *   console.log('Result:', value);
+ * }
+ *
+ * // Asynchronous error handling
+ * const [asyncErr, result] = await shield(async () => {
+ *   const response = await fetch('/api/data');
+ *   if (!response.ok) throw new Error('API error');
+ *   return response.json();
+ * });
+ * if (asyncErr) {
+ *   console.error('API call failed:', asyncErr);
+ * } else {
+ *   processData(result);
+ * }
+ *
+ * // API calls with fallbacks
+ * const [fetchErr, data] = await shield(fetchUserData(userId));
+ * const userData = fetchErr ? getCachedUserData(userId) : data;
+ *
+ * // File operations
+ * const [fileErr, content] = shield(() => readFileSync('config.json'));
+ * if (fileErr) {
+ *   console.warn('Could not read config, using defaults');
+ *   return defaultConfig;
+ * }
+ * ```
  *
- * const [asyncErr, result] = await shield(fetchData());
- * if (asyncErr) throw asyncErr;
+ * @example
+ * ```ts
+ * // In async functions
+ * async function safeApiCall() {
+ *   const [err, result] = await shield(callExternalAPI());
+ *   if (err) {
+ *     await logError(err);
+ *     return null;
+ *   }
+ *   return result;
+ * }
+ *
+ * // In event handlers
+ * function handleSubmit(formData) {
+ *   const [validationErr, validatedData] = shield(() => validateForm(formData));
+ *   if (validationErr) {
+ *     showValidationError(validationErr);
+ *     return;
+ *   }
+ *   submitData(validatedData);
+ * }
  * ```
  */
 declare function shield<T, E = Error>(operation: Promise<T>): Promise<[E | null, T | null]>;
@@ -253,6 +509,12 @@ declare function shield<T, E = Error>(operation: () => T): [E | null, T | null];
  *
  * @param {...ClassValue[]} inputs - Class names to merge.
  * @returns {string} - A string of merged class names.
+ *
+ * @example
+ * ```ts
+ * cn('px-2 py-1', 'bg-red-500') // 'px-2 py-1 bg-red-500'
+ * cn('px-2', 'px-4') // 'px-4' (Tailwind resolves conflicts)
+ * ```
  */
 declare function cn(...inputs: ClassValue[]): string;
 /**
@@ -263,16 +525,40 @@ declare function cn(...inputs: ClassValue[]): string;
  * @param  href - The target URL.
  * @param  path - The current browser path.
  * @returns - True if the navigation is active, false otherwise.
+ *
+ * @example
+ * ```ts
+ * isNavActive('/about', '/about/team') // true
+ * isNavActive('/contact', '/about') // false
+ * ```
  */
 declare function isNavActive(href: string, path: string): boolean;
 /**
  * Checks if a link is active, considering optional localization prefixes.
  *
- * @param {Object} params - Parameters object.
- * @param {string} params.path - The target path of the link.
- * @param {string} params.currentPath - The current browser path.
- * @param {string[]} [params.locales=['en', 'es', 'de', 'zh', 'bn', 'fr', 'it', 'nl']] - Supported locale prefixes.
- * @returns {boolean} - True if the link is active, false otherwise.
+ * Compares paths while ignoring locale prefixes (e.g., /en/, /fr/) for consistent
+ * navigation highlighting across different language versions of the same page.
+ *
+ * @param params - Parameters object.
+ * @param params.path - The target path of the link.
+ * @param params.currentPath - The current browser path.
+ * @param params.locales - Supported locale prefixes to ignore during comparison.
+ * @param params.exact - Whether to require exact path match (default: true). If false, checks if current path starts with target path.
+ * @returns True if the link is active, false otherwise.
+ *
+ * @example
+ * ```ts
+ * // Exact match
+ * isLinkActive({ path: '/about', currentPath: '/about' }) // true
+ * isLinkActive({ path: '/about', currentPath: '/about/team' }) // false
+ *
+ * // With locales
+ * isLinkActive({ path: '/about', currentPath: '/en/about' }) // true
+ * isLinkActive({ path: '/about', currentPath: '/fr/about' }) // true
+ *
+ * // Partial match
+ * isLinkActive({ path: '/blog', currentPath: '/blog/post-1', exact: false }) // true
+ * ```
  */
 declare function isLinkActive({
   path,
@@ -288,29 +574,74 @@ declare function isLinkActive({
 /**
  * Cleans a file path by removing the `/public/` prefix if present.
  *
- * @param  src - The source path to clean.
- * @returns - The cleaned path.
+ * Useful when working with static assets that may have been processed
+ * or when normalizing paths between development and production environments.
+ *
+ * @param src - The source path to clean.
+ * @returns The cleaned path with `/public/` prefix removed and whitespace trimmed.
+ *
+ * @example
+ * ```ts
+ * cleanSrc('/public/images/logo.png') // '/images/logo.png'
+ * cleanSrc('images/logo.png') // 'images/logo.png'
+ * cleanSrc('  /public/docs/readme.md  ') // '/docs/readme.md'
+ * ```
  */
 declare function cleanSrc(src: string): string;
 /**
  * Smoothly scrolls to the top or bottom of a specified container.
  *
- * @param  containerSelector - The CSS selector or React ref for the container.
- * @param  to - Specifies whether to scroll to the top or bottom.
+ * Provides smooth scrolling animation to either end of a scrollable element.
+ * Accepts either a CSS selector string or a React ref to the container element.
+ *
+ * @param containerSelector - The CSS selector string or React ref for the scrollable container.
+ * @param to - Direction to scroll: 'top' for top of container, 'bottom' for bottom.
+ *
+ * @example
+ * ```ts
+ * // Scroll to top using selector
+ * scrollTo('.main-content', 'top');
+ *
+ * // Scroll to bottom using ref
+ * scrollTo(containerRef, 'bottom');
+ * ```
  */
 declare const scrollTo: (containerSelector: string | React.RefObject<HTMLDivElement>, to: "top" | "bottom") => void;
 /**
- * Copies a given string to the clipboard.
+ * Copies a given string to the clipboard using the modern Clipboard API.
+ *
+ * Safely attempts to copy text to the user's clipboard. Falls back gracefully
+ * if the Clipboard API is not available or if the operation fails.
  *
- * @param  value - The value to copy to the clipboard.
- * @param  [onSuccess=() => {}] - Optional callback executed after successful copy.
+ * @param value - The text value to copy to the clipboard.
+ * @param onSuccess - Optional callback executed after successful copy operation.
+ *
+ * @example
+ * ```ts
+ * copyToClipboard('Hello World!', () => {
+ *   console.log('Text copied successfully');
+ * });
+ * ```
  */
 declare const copyToClipboard: (value: string, onSuccess?: () => void) => void;
 /**
- * Converts camelCase, PascalCase, kebab-case, snake_case into normal case.
+ * Converts various case styles (camelCase, PascalCase, kebab-case, snake_case) into readable normal case.
+ *
+ * Transforms technical naming conventions into human-readable titles by:
+ * - Adding spaces between words
+ * - Capitalizing the first letter of each word
+ * - Handling common separators (-, _, camelCase boundaries)
+ *
+ * @param inputString - The string to convert (supports camelCase, PascalCase, kebab-case, snake_case).
+ * @returns The converted string in normal case (title case).
  *
- * @param  inputString - The string need to be converted into normal case
- * @returns - Normal Case
+ * @example
+ * ```ts
+ * convertToNormalCase('camelCase') // 'Camel Case'
+ * convertToNormalCase('kebab-case') // 'Kebab Case'
+ * convertToNormalCase('snake_case') // 'Snake Case'
+ * convertToNormalCase('PascalCase') // 'Pascal Case'
+ * ```
  */
 declare function convertToNormalCase(inputString: string): string;
 /**
@@ -327,6 +658,17 @@ declare const convertToSlug: (str: string) => string;
  * Checks if the code is running in a server-side environment.
  *
  * @returns - True if the code is executed in SSR (Server-Side Rendering) context, false otherwise
+ *
+ * @example
+ * ```ts
+ * if (isSSR) {
+ *   // Server-side only code
+ *   console.log('Running on server');
+ * } else {
+ *   // Client-side only code
+ *   window.addEventListener('load', () => {});
+ * }
+ * ```
  */
 declare const isSSR: boolean;
 /**
@@ -334,6 +676,13 @@ declare const isSSR: boolean;
  *
  * @param str - The SVG string to encode
  * @returns - Base64-encoded string representation of the SVG
+ *
+ * @example
+ * ```ts
+ * const svg = '<svg><circle cx="50" cy="50" r="40"/></svg>';
+ * const base64 = svgToBase64(svg);
+ * // Use in data URL: `data:image/svg+xml;base64,${base64}`
+ * ```
  */
 declare const svgToBase64: (str: string) => string;
 /**
@@ -375,9 +724,23 @@ type DebouncedFunction<F extends (...args: any[]) => any> = {
  * @throws {RangeError} If the `wait` parameter is negative.
  *
  * @example
+ * ```ts
+ * // Basic debouncing
  * const log = debounce((message: string) => console.log(message), 200);
  * log('Hello'); // Logs "Hello" after 200ms if no other call is made.
  * console.log(log.isPending); // true if the timer is active.
+ *
+ * // Immediate execution
+ * const save = debounce(() => saveToServer(), 500, { immediate: true });
+ * save(); // Executes immediately, then waits 500ms for subsequent calls
+ *
+ * // Check pending state
+ * const debouncedSearch = debounce(searchAPI, 300);
+ * debouncedSearch('query');
+ * if (debouncedSearch.isPending) {
+ *   showLoadingIndicator();
+ * }
+ * ```
  */
 declare function debounce<F extends (...args: any[]) => any>(function_: F, wait?: number, options?: {
   immediate: boolean;
@@ -412,9 +775,29 @@ type ThrottledFunction<F extends (...args: any[]) => any> = {
  * @throws {RangeError} If the `wait` parameter is negative.
  *
  * @example
+ * ```ts
+ * // Basic throttling (leading edge by default)
  * const log = throttle((message: string) => console.log(message), 200);
- * log('Hello'); // Logs "Hello" immediately if leading is true.
- * console.log(log.isPending); // true if the timer is active.
+ * log('Hello'); // Logs "Hello" immediately
+ * log('World'); // Ignored for 200ms
+ * console.log(log.isPending); // true if within throttle window
+ *
+ * // Trailing edge only
+ * const trailingLog = throttle(() => console.log('trailing'), 200, {
+ *   leading: false,
+ *   trailing: true
+ * });
+ * trailingLog(); // No immediate execution
+ * // After 200ms: logs "trailing"
+ *
+ * // Both edges
+ * const bothLog = throttle(() => console.log('both'), 200, {
+ *   leading: true,
+ *   trailing: true
+ * });
+ * bothLog(); // Immediate execution
+ * // After 200ms: executes again if called during window
+ * ```
  */
 declare function throttle<F extends (...args: any[]) => any>(function_: F, wait?: number, options?: {
   leading?: boolean;
@@ -422,26 +805,31 @@ declare function throttle<F extends (...args: any[]) => any>(function_: F, wait?
 }): ThrottledFunction<F>;
 /**
  * Formats a string by replacing each '%s' placeholder with the corresponding argument.
- * This function mimics the basic behavior of C's printf for %s substitution.
  *
- * It supports both calls like `printf(format, ...args)` and `printf(format, argsArray)`.
+ * Mimics the basic behavior of C's printf for %s substitution. Supports both
+ * variadic arguments and array-based argument passing. Extra placeholders
+ * are left as-is, missing arguments result in empty strings.
  *
  * @param format - The format string containing '%s' placeholders.
- * @param args - The values to substitute into the placeholders, either as separate arguments or as a single array.
- * @returns The formatted string with all '%s' replaced by the provided arguments.
+ * @param args - The values to substitute, either as separate arguments or a single array.
+ * @returns The formatted string with placeholders replaced by arguments.
  *
  * @example
  * ```ts
- * const message = printf("%s love %s", "I", "Bangladesh");
- * // message === "I love Bangladesh"
+ * // Basic usage with separate arguments
+ * printf("%s love %s", "I", "Bangladesh") // "I love Bangladesh"
+ *
+ * // Using array of arguments
+ * printf("%s love %s", ["I", "Bangladesh"]) // "I love Bangladesh"
  *
- * const arr = ["I", "Bangladesh"];
- * const message2 = printf("%s love %s", arr);
- * // message2 === "I love Bangladesh"
+ * // Extra placeholders remain unchanged
+ * printf("%s %s %s", "Hello", "World") // "Hello World %s"
  *
- * // If there are too few arguments:
- * const incomplete = printf("Bangladesh is %s %s", "beautiful");
- * // incomplete === "Bangladesh is beautiful"
+ * // Missing arguments become empty strings
+ * printf("%s and %s", "this") // "this and "
+ *
+ * // Multiple occurrences
+ * printf("%s %s %s", "repeat", "repeat", "repeat") // "repeat repeat repeat"
  * ```
  */
 declare function printf(format: string, ...args: unknown[]): string;
@@ -449,29 +837,54 @@ declare function printf(format: string, ...args: unknown[]): string;
  * Merges multiple refs into a single ref callback.
  *
  * @param refs - An array of refs to merge.
- *
  * @returns - A function that updates the merged ref with the provided value.
+ *
+ * @example
+ * ```tsx
+ * const MyComponent = () => {
+ *   const ref1 = useRef<HTMLDivElement>(null);
+ *   const ref2 = useRef<HTMLDivElement>(null);
+ *
+ *   const mergedRef = mergeRefs(ref1, ref2);
+ *
+ *   return <div ref={mergedRef}>Content</div>;
+ * };
+ * ```
  */
 type MergeRefs = <T>(...refs: Array<React.Ref<T> | undefined>) => React.RefCallback<T>;
 declare const mergeRefs: MergeRefs;
 /**
- * Navigates to the specified client-side hash without ssr.
- * use `scroll-margin-top` with css to add margins
+ * Navigates to the specified client-side hash without triggering SSR.
  *
- * @param id - The ID of the element without # to navigate to.
+ * Smoothly scrolls to an element by ID and updates the URL hash.
+ * Use `scroll-margin-top` CSS property to add margins for fixed headers.
+ *
+ * @param id - The ID of the element (without #) to navigate to.
+ * @param opts - Additional options for scrollIntoView.
+ *
+ * @example
+ * ```ts
+ * // Navigate to an element
+ * goToClientSideHash('section-about');
  *
- * @example goToClientSideHash('my-element');
+ * // With custom scroll behavior
+ * goToClientSideHash('contact', { behavior: 'auto', block: 'center' });
+ * ```
  */
 declare function goToClientSideHash(id: string, opts?: ScrollIntoViewOptions): void;
 /**
  * Escapes a string for use in a regular expression.
  *
  * @param str - The string to escape
- * @returns - The escaped string
+ * @returns - The escaped string safe for use in RegExp constructor
  *
  * @example
+ * ```ts
  * const escapedString = escapeRegExp('Hello, world!');
  * // escapedString === 'Hello\\, world!'
+ *
+ * const regex = new RegExp(escapeRegExp(userInput));
+ * ```
  */
 declare function escapeRegExp(str: string): string;
 /**
@@ -487,6 +900,13 @@ declare function escapeRegExp(str: string): string;
  * @param options.removeAccents - Whether to remove diacritic marks like accents (default: true)
  * @param options.removeNonAlphanumeric - Whether to trim non-alphanumeric characters from the edges (default: true)
  * @returns The normalized string
+ *
+ * @example
+ * ```ts
+ * normalizeText('Café') // 'cafe'
+ * normalizeText('  Hello!  ') // 'hello'
+ * normalizeText('José', { removeAccents: false }) // 'josé'
+ * ```
  */
 declare function normalizeText(str?: string | null, options?: {
   lowercase?: boolean;