@react-hive/honey-utils 3.13.1 → 3.14.0

package/dist/function.d.ts

@@ -1,181 +0,0 @@
-export declare const noop: () => void;
-/**
- * Checks if a value is a function.
- *
- * @param value - The value to check.
- *
- * @returns `true` if the value is a function; otherwise, `false`.
- */
-export declare const isFunction: (value: unknown) => value is Function;
-/**
- * Creates a function that negates the result of the given predicate function.
- *
- * @template Args - Argument types of the predicate function.
- *
- * @param fn - A function that returns any value.
- *
- * @returns A new function that returns the negated result of the original function.
- *
- * @example
- * ```ts
- * const isEven = (n: number) => n % 2 === 0;
- * const isOdd = not(isEven);
- *
- * console.log(isOdd(2)); // false
- * console.log(isOdd(3)); // true
- * ```
- */
-export declare const not: <Args extends unknown[]>(fn: (...args: Args) => any) => ((...args: Args) => boolean);
-/**
- * Invokes the given input if it is a function, passing the provided arguments.
- * Otherwise, returns the input as-is.
- *
- * @template Args - Tuple of argument types to pass to the function.
- * @template Result - Return type of the function or the value.
- *
- * @param input - A function to invoke with `args`, or a direct value of type `Result`.
- * @param args - Arguments to pass if `input` is a function.
- *
- * @returns The result of invoking the function, or the original value if it's not a function.
- */
-export declare const invokeIfFunction: <Args extends unknown[], Result>(input: ((...args: Args) => Result) | Result, ...args: Args) => Result;
-/**
- * Creates a promise that resolves after the specified delay.
- *
- * Useful for creating artificial delays, implementing timeouts, or spacing operations.
- *
- * @param delayMs - The delay in milliseconds.
- *
- * @returns A promise that resolves after the specified delay.
- *
- * @example
- * ```ts
- * // Wait for 1 second
- * await delay(1000);
- * console.log('This logs after 1 second');
- *
- * // Use with other async operations
- * const fetchWithTimeout = async () => {
- *   const timeoutPromise = delay(5000).then(() => {
- *     throw new Error('Request timed out');
- *   });
- *
- *   return Promise.race([fetchData(), timeoutPromise]);
- * }
- * ```
- */
-export declare const delay: (delayMs: number) => Promise<void>;
-/**
- * Wraps a promise with a timeout. If the promise does not settle within the specified time,
- * it will reject with a timeout error.
- *
- * @template T - The type of the promise result.
- *
- * @param promise - The promise to wrap.
- * @param timeoutMs - Timeout duration in milliseconds.
- * @param errorMessage - Optional custom error message.
- *
- * @returns A promise that resolves or rejects with the original promise,
- *          or rejects with a timeout error if the duration is exceeded.
- *
- * @example
- * ```ts
- * // Rejects if fetch takes longer than 3 seconds
- * const response = await timeout(fetch('/api/data'), 3000);
- *
- * // With custom message
- * await timeout(fetchData(), 2000, 'Too long');
- * ```
- */
-export declare const timeout: <T>(promise: Promise<T>, timeoutMs: number, errorMessage?: string) => Promise<T>;
-interface RetryOptions {
-    /**
-     * Maximum number of retry attempts before failing.
-     *
-     * @default 3
-     */
-    maxAttempts?: number;
-    /**
-     * Delay in milliseconds between retry attempts.
-     * If `backoff` is true, this is the base delay for exponential backoff.
-     *
-     * @default 300
-     */
-    delayMs?: number;
-    /**
-     * Whether to use exponential backoff for delays between attempts.
-     * When enabled, the delay is multiplied by 2 ^ (`attempt` - 1).
-     *
-     * @default true
-     */
-    backoff?: boolean;
-    /**
-     * Optional callback triggered before each retry attempt.
-     *
-     * @param attempt - The current attempt number (starting from 1).
-     * @param error - The error that caused the retry.
-     */
-    onRetry?: (attempt: number, error: unknown) => void;
-}
-/**
- * Wraps an asynchronous function with retry logic.
- *
- * The returned function will attempt to call the original function up to `maxAttempts` times,
- * with a delay between retries. If all attempts fail, the last encountered error is thrown.
- *
- * Useful for operations that may fail intermittently, such as network requests.
- *
- * @template Task - The type of the async function to wrap.
- * @template TaskResult - The result type of the async function.
- *
- * @param task - The async function to wrap with retry logic.
- * @param options - Configuration options for retry behavior.
- *
- * @returns A function that wraps the original function with retry support.
- *
- * @example
- * ```ts
- * async function fetchData() {
- *   const response = await fetch('/api/data');
- *
- *   if (!response.ok) {
- *    throw new Error('Network error');
- *   }
- *
- *   return await response.json();
- * }
- *
- * const fetchWithRetry = retry(fetchData, {
- *   maxAttempts: 5,
- *   delayMs: 500,
- *   onRetry: (attempt, error) => {
- *     console.warn(`Attempt ${attempt} failed:`, error);
- *   }
- * });
- *
- * fetchWithRetry()
- *   .then(data => console.log('Success:', data))
- *   .catch(error => console.error('Failed after retries:', error));
- * ```
- */
-export declare const retry: <Task extends (...args: unknown[]) => Promise<TaskResult>, TaskResult>(task: Task, { maxAttempts, delayMs, backoff, onRetry }?: RetryOptions) => ((...args: Parameters<Task>) => Promise<TaskResult>);
-/**
- * Wraps a function so that it can only be executed once.
- * The wrapped function remembers (caches) the result of the first invocation
- * and returns that same result for all subsequent calls, regardless of the arguments provided.
- *
- * Common use cases include:
- * - initializing singletons
- * - running setup logic only once
- * - avoiding repeated expensive computations
- *
- * @template T - A function type whose return value should be cached.
- *
- * @param fn - The function to execute at most once.
- *
- * @returns A new function with the same signature as `fn`, but guaranteed to
- *          execute `fn` only on the first call and return the cached result
- *          thereafter.
- */
-export declare const once: <T extends (...args: any[]) => any>(fn: T) => T;
-export {};

package/dist/string.d.ts

@@ -1,111 +0,0 @@
-/**
- * Checks if a value is a string.
- *
- * @param value - The value to check.
- *
- * @returns `true` if the value is a string; otherwise, `false`.
- */
-export declare const isString: (value: unknown) => value is string;
-/**
- * Checks whether the provided value is considered "empty".
- *
- * A value is considered empty if it is:
- * - `null`
- * - `undefined`
- * - `''`
- *
- * @param value - The value to check.
- *
- * @returns `true` if the value is empty; otherwise, `false`.
- */
-export declare const isNilOrEmptyString: (value: unknown) => value is null | undefined;
-/**
- * Converts a string to kebab-case format.
- *
- * This function transforms camelCase or PascalCase strings into kebab-case by inserting
- * hyphens between lowercase and uppercase letters, then converting everything to lowercase.
- *
- * @param input - The string to convert to kebab-case.
- *
- * @returns The kebab-case formatted string.
- *
- * @example
- * ```ts
- * toKebabCase('helloWorld'); // → 'hello-world'
- * toKebabCase('HelloWorld'); // → 'hello-world'
- * toKebabCase('hello123World'); // → 'hello123-world'
- * ```
- */
-export declare const toKebabCase: (input: string) => string;
-/**
- * Converts a camelCase string to dash-case format.
- *
- * This function transforms camelCase strings into dash-case by inserting
- * hyphens before uppercase letters and converting them to lowercase.
- * The function ensures that no hyphen is added at the start of the output string,
- * even if the input begins with an uppercase letter.
- *
- * @param input - The camelCase string to convert to dash-case.
- *
- * @returns The dash-case formatted string.
- *
- * @example
- * ```ts
- * camelToDashCase('helloWorld'); // → 'hello-world'
- * camelToDashCase('HelloWorld'); // → 'hello-world'
- * camelToDashCase('backgroundColor'); // → 'background-color'
- * ```
- */
-export declare const camelToDashCase: (input: string) => string;
-/**
- * Splits a camelCase or PascalCase string into separate words with spaces.
- *
- * This function inserts spaces between lowercase and uppercase letters,
- * making camelCase or PascalCase strings more human-readable without
- * altering their original capitalization.
- *
- * @param input - The camelCase or PascalCase string to split into words.
- *
- * @returns The string with spaces inserted between words.
- *
- * @example
- * ```ts
- * camelToWords('helloWorld'); // → 'hello World'
- * camelToWords('HelloWorld'); // → 'Hello World'
- * camelToWords('userIDNumber'); // → 'user ID Number'
- * ```
- */
-export declare const camelToWords: (input: string) => string;
-/**
- * Splits a string into an array of filtered from redundant spaces words.
- *
- * @param input - The input string to be split.
- *
- * @returns An array of words from the input string.
- */
-export declare const splitStringIntoWords: (input: string) => string[];
-/**
- * Generates a short, consistent hash string from an input string using a DJB2-inspired algorithm.
- *
- * This function uses a variation of the DJB2 algorithm, which is a simple yet effective hashing algorithm
- * based on bitwise XOR (`^`) and multiplication by 33. It produces a non-negative 32-bit integer,
- * which is then converted to a base-36 string (digits + lowercase letters) to produce a compact output.
- *
- * Useful for:
- * - Generating stable class names in CSS-in-JS libraries.
- * - Producing consistent cache keys.
- * - Quick and lightweight hashing needs where cryptographic security is not required.
- *
- * ⚠️ This is not cryptographically secure and should not be used for hashing passwords or sensitive data.
- *
- * @param input - The input string to hash.
- *
- * @returns A short, base-36 encoded hash string.
- *
- * @example
- * ```ts
- * const className = hashString('background-color: red;');
- * // → 'e4k1z0x'
- * ```
- */
-export declare const hashString: (input: string) => string;