mirror of
https://github.com/wassname/DefinitelyTyped.git
synced 2026-09-09 11:13:57 +08:00
Add type definitions of shuffle-array package
This commit is contained in:
Vendored
+42
@@ -0,0 +1,42 @@
|
||||
// Type definitions for shuffle-array
|
||||
// Project: https://github.com/pazguille/shuffle-array
|
||||
// Definitions by: rhysd <https://rhysd.github.io>
|
||||
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
||||
|
||||
declare module "shuffle-array" {
|
||||
/**
|
||||
* copy - Sets if should return a shuffled copy of the given array. By default it's a falsy value.
|
||||
* rng - Specifies a custom random number generator.
|
||||
*/
|
||||
interface ShuffleOption {
|
||||
copy?: boolean;
|
||||
rng?: () => number;
|
||||
}
|
||||
/**
|
||||
* picks - Specifies how many random elements you want to pick. By default it picks 1.
|
||||
* rng - Specifies a custom random number generator.
|
||||
*/
|
||||
interface PickOption {
|
||||
picks?: number;
|
||||
rng?: () => number;
|
||||
}
|
||||
interface ShuffleArray {
|
||||
/**
|
||||
* Randomizes the order of the elements in a given array.
|
||||
*
|
||||
* arr - The given array.
|
||||
* options - Optional configuration options.
|
||||
*/
|
||||
<T>(arr: T[], options?: ShuffleOption): T[];
|
||||
/**
|
||||
* Pick one or more random elements from the given array.
|
||||
*
|
||||
* arr - The given array.
|
||||
* options - Optional configuration options.
|
||||
*/
|
||||
pick<T>(arr: T[], options?: Object): T[];
|
||||
}
|
||||
var shuffle: ShuffleArray;
|
||||
export = shuffle;
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user