npm.io
2.1.3 • Published 4d ago

@hugoalh/shuffle-array

Licence
MIT
Version
2.1.3
Deps
0
Size
7 kB
Vulns
0
Weekly
0
Stars
1

Shuffle Array (ES)

MIT

DistBoard @hugoalh ● GitHub ● JSR ● NPM

An ECMAScript module to shuffle the array's indexes.

Runtime Targets

Any runtime which support ECMAScript should able to use this; These runtimes are officially supported:

Runtime Permissions

This does not request any runtime permission.

Entrypoints

Name Path Description
. ./mod.ts Default.

  • Different runtimes have vary support for the entrypoints, visit the runtime documentation for more information.
  • These are not part of the public APIs hence should not be used:
    • Benchmark/Test file (e.g.: example.bench.ts, example.test.ts).
    • Entrypoint name or path include any underscore prefix (e.g.: _example.ts, foo/_example.ts).
    • Identifier/Namespace/Symbol include any underscore prefix (e.g.: _example, Foo._example).

APIs

  • function shuffleArray<T>(item: readonly T[], prng?: PseudoRandomNumberGenerator): T[];
  • type PseudoRandomNumberGenerator = () => number;

Examples

  • const item = [3, 7, 25, 26, 42, 62, 71, 76, 92, 93];
    
    shuffleArray(item);
    //=> [62, 93, 26, 42, 25, 7, 76, 71, 3, 92]
    
    shuffleArray(item);
    //=> [42, 3, 26, 62, 93, 7, 76, 25, 92, 71]

Keywords