artytext/dist/utils/random.d.ts

A comprehensive utility library for text manipulation, slug generation, password generation, case conversion, and more. Works with both TypeScript and JavaScript.

import { RandomOptions } from '../types';
/**
 * Generate a random integer between min and max (inclusive)
 * @param min - Minimum value (default: 0)
 * @param max - Maximum value (default: 100)
 * @returns Random integer
 */
export declare function randomInt(min?: number, max?: number): number;
/**
 * Generate a random float between min and max
 * @param min - Minimum value (default: 0)
 * @param max - Maximum value (default: 1)
 * @param decimals - Number of decimal places (default: 2)
 * @returns Random float
 */
export declare function randomFloat(min?: number, max?: number, decimals?: number): number;
/**
 * Generate a random string with specified options
 * @param options - Random string generation options
 * @returns Random string
 */
export declare function randomString(options?: RandomOptions): string;
/**
 * Generate a random number string
 * @param length - Length of the number string (default: 6)
 * @returns Random number string
 */
export declare function randomNumberString(length?: number): string;
/**
 * Generate a random hexadecimal string
 * @param length - Length of the hex string (default: 8)
 * @param uppercase - Whether to use uppercase letters (default: false)
 * @returns Random hex string
 */
export declare function randomHex(length?: number, uppercase?: boolean): string;
/**
 * Generate a random UUID (version 4)
 * @returns Random UUID string
 */
export declare function randomUUID(): string;
/**
 * Generate a random color in hex format
 * @param includeHash - Whether to include # prefix (default: true)
 * @returns Random hex color
 */
export declare function randomColor(includeHash?: boolean): string;
/**
 * Generate a random RGB color
 * @returns Random RGB color object
 */
export declare function randomRGB(): {
    r: number;
    g: number;
    b: number;
};
/**
 * Generate a random item from an array
 * @param array - Array to pick from
 * @returns Random item from array
 */
export declare function randomItem<T>(array: T[]): T;
/**
 * Generate multiple random items from an array
 * @param array - Array to pick from
 * @param count - Number of items to pick
 * @param allowDuplicates - Whether to allow duplicate picks (default: false)
 * @returns Array of random items
 */
export declare function randomItems<T>(array: T[], count: number, allowDuplicates?: boolean): T[];
/**
 * Generate a random boolean
 * @param probability - Probability of true (0-1, default: 0.5)
 * @returns Random boolean
 */
export declare function randomBoolean(probability?: number): boolean;
/**
 * Generate a random date within a range
 * @param startDate - Start date (default: 1 year ago)
 * @param endDate - End date (default: now)
 * @returns Random date
 */
export declare function randomDate(startDate?: Date, endDate?: Date): Date;
//# sourceMappingURL=random.d.ts.map