· Homepage · Report Bug / Request Feature ·
## Table of Contents - [Installation](#Install) - [Usage](#usage) - [Test](#run-tests) - [Contact](#contact) - [Contributing](#Contributing) - [License](#license) ## Install ### NPM: ```sh npm install @compactjs/random ``` ## Usage ```typescript /** * Returns a pseudo random number between min and max. * (min inclusive, max exclusive) * Max can be smaller than min. * If max is not omitted, between 0 and min. * If min is not omitted, between 0 and 1. */ function random(min?: number, max?: number): number; /** * Returns a random item from a given array * @param choices to select from */ function pick(choices: any[]): any; ``` ### As module: ```javascript import { random, pick } from '@compactjs/random'; ``` ### Example: ```javascript random(10, 100); // => random value between (including) 10 and 100 random(10); // => random value between 0 and 10 random(); // => random value between 0 and 1 pick([0, 1, 2, 3]); // => picks random value from 0,1,2,3 ``` ## Run tests ```sh npm run test ``` ## Contact 👤 **Timo Bechtel** - Website: https://timobechtel.com - Twitter: [@TimoBechtel](https://twitter.com/TimoBechtel) - GitHub: [@TimoBechtel](https://github.com/TimoBechtel) ## 🤝 Contributing Contributions, issues and feature requests are welcome!