@smakss/random-array-element
v2.0.3
Published
Efficiently select unique, non-repeating random elements from arrays with @smakss/random-array-element. Ideal for varied applications needing random but exhaustive array item selection.
Downloads
145
Maintainers
Readme
Random Array Element without Repetition
Selecting a random element from an array is simple with Math.random()
. However, if you need to ensure that each element is only selected once until all elements have been chosen, @smakss/random-array-element
is the ideal solution. Utilizing closures, this package allows you to initialize a function once and then repeatedly obtain unique, randomly-selected elements from your array, without repeats until the array is exhausted.
Demo
You can check the working demo on RunKit.
or
Installation
Install the package using npm or Yarn:
npm i @smakss/random-array-element
# or
yarn add @smakss/random-array-element
Usage
To include it with CommonJS module you can do this:
const randomArrayElement = require('@smakss/random-array-element');
For ECMAScript modules:
import randomArrayElement from '@smakss/random-array-element';
Example usage:
// Initialize once for an array
const getRandomElement = randomArrayElement(['apple', 'banana', 'cherry']);
console.log(getRandomElement()); // Result: 'banana' (example output)
console.log(getRandomElement()); // Result: 'apple' (example output)
// ...after all items have been returned, it resets.
console.log(getRandomElement()); // Result: 'cherry' (example output)
// ...continues to return a new random item.
If an empty or non-array input is passed, the function will return -1, indicating no selection can be made:
const getRandomElement = randomArrayElement([]);
console.log(getRandomElement()); // Result: -1
Contributing
Contributions are welcome! Please see CONTRIBUTING.md for guidelines and details.
Code of Conduct
To ensure a welcoming and safe community, our Code of Conduct outlines expected behaviors for all participants.