@ts-utilkit/random

random Functions - TypeScript utility functions for random operations.

Installation

npm install @ts-utilkit/random

Features

• 🚀 TypeScript-first with complete type definitions
• ✅ Comprehensive test coverage (>95%)
• 📦 Tree-shakeable ESM and CommonJS support
• 🔒 Type-safe with strict TypeScript configuration
• 📖 Extensive JSDoc documentation

Available Functions (25)

• randomInt - Generates a random integer within a range
• randomFloat - Generates a random floating-point number within a range
• randomBoolean - Generates a random boolean value
• randomElement - Selects a random element from an array
• randomElements - Selects multiple random elements from an array
• randomString - Generates a random string of specified length
• randomHex - Generates a random hexadecimal string
• randomUUID - Generates a random UUID (v4)
• randomColor - Generates a random color in hex format
• randomRGB - Generates a random RGB color object
• randomDate - Generates a random date within a range
• randomChoice - Makes a random choice based on weighted probabilities
• shuffleArray - Randomly shuffles an array (Fisher-Yates algorithm)
• randomSample - Takes a random sample of specified size from an array
• randomPassword - Generates a random password with configurable options
• randomAlphanumeric - Generates a random alphanumeric string
• randomDigits - Generates a random string of digits
• randomLetters - Generates a random string of letters
• randomBytes - Generates cryptographically secure random bytes
• randomIntCrypto - Generates a cryptographically secure random integer
• randomFloatCrypto - Generates a cryptographically secure random float
• randomIP - Generates a random IP address (IPv4 or IPv6)
• randomMACAddress - Generates a random MAC address
• randomPhoneNumber - Generates a random phone number
• randomEmail - Generates a random email address

Usage Examples

import { randomInt, randomElement, randomPassword, shuffleArray } from '@ts-utilkit/random';

// Random integer
const dice = randomInt(1, 6);
// Result: Random number between 1 and 6

// Random element from array
const fruits = ['apple', 'banana', 'orange'];
const randomFruit = randomElement(fruits);
// Result: One random fruit

// Secure password generation
const password = randomPassword(16, { uppercase: true, numbers: true, symbols: true });
// Result: "aB7#kL9$pQ2@mN5!"

// Shuffle array
const cards = [1, 2, 3, 4, 5];
const shuffled = shuffleArray(cards);
// Result: [3, 1, 5, 2, 4] (random order)

API Documentation

For complete API documentation, please visit the main repository.

License

MIT © MForofontov

Contributing

Contributions are welcome! Please see the main repository for contribution guidelines.