Installation

npm install @charpeni/one-of

Usage

oneOf is a function accepting either an array or an object and returning a random element or entry from it.

It was built mostly to be used in tests or for generating random data (it can also be used safely for any other type of behaviors, including production apps), e.g.:

<Card color={oneOf(['red', 'blue', 'green'])}>{/* ... */}</Card>

[!NOTE] oneOf is a type-safe function. It will infer the type of the array or object passed as an argument and return the corresponding type to ensure the return type is a union of possibilities rather than a primitive type (1 | 2 instead of number[]).

If the input is passed inlined, the const modifier will be applied and therefore the type will be inferred as ReadonlyArray or readonly Record. Otherwise, using as const is suggested.

import { oneOf } from '@charpeni/one-of';

// Returns a random element from the array
const element = oneOf([1, 2, 3]); // 2
//    ^? const element: 1 | 2 | 3

// Returns a random entry from the object
const entry = oneOf({ a: 1, b: 2, c: 3 }); // ['b', 2]
//    ^? const entry: ['a', 1] | ['b', 2] | ['c', 3]

Specific functions are also available: oneElementOf and oneEntryOf, that's what oneOf uses under the hood:

import { oneElementOf, oneEntryOf } from '@charpeni/one-of';

// Returns a random element from the array
const element = oneElementOf([1, 2, 3]); // 2
//    ^? const element: 1 | 2 | 3

// Returns a random entry from the object
const entry = oneEntryOf({ a: 1, b: 2, c: 3 }); // ['b', 2]
//    ^? const entry: ['a', 1] | ['b', 2] | ['c', 3]

License

@charpeni/one-of is MIT licensed.