@types/secure-shuffle
TypeScript icon, indicating that this package has built-in type declarations

2.0.2 • Public • Published

Installation

npm install --save @types/secure-shuffle

Summary

This package contains type definitions for secure-shuffle (https://github.com/emilbayes/secure-shuffle).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/secure-shuffle.

index.d.ts

export = secureShuffle;

/**
 * Shuffle an array using `secure-random-uniform` as the RNG.
 *
 * Takes an array-like structure (eg. `Buffer`) and shuffles it. Note that the
 * original will be mutated for performance reasons. You might want to copy
 * the structure before passing it, depending on your use-case.
 *
 * As a convenience, the passed structure will be returned.
 *
 * @example
 * import secureShuffle = require('secure-shuffle')
 *
 * const arr = [1, 2, 3, 4, 5, 6, 7, 8, 9]
 *
 * const sarr = secureShuffle(arr.slice(0)) // sarr is now a shuffled copy of arr
 *
 * secureShuffle(arr) // arr is now shuffled
 */
declare function secureShuffle<TArr extends ArrayLike<number>>(arr: TArr): TArr;

Additional Details

  • Last updated: Tue, 07 Nov 2023 15:11:36 GMT
  • Dependencies: none

Credits

These definitions were written by BendingBender.

Readme

Keywords

none

Package Sidebar

Install

npm i @types/secure-shuffle

Weekly Downloads

2

Version

2.0.2

License

MIT

Unpacked Size

4.01 kB

Total Files

5

Last publish

Collaborators

  • types