Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "random/shuffle/docs/types/index.d"

Index

Interfaces

Type aliases

Variables

Type aliases

ShuffleFunction

ShuffleFunction: (arr: ArrayLike<any>, options?: Options) => ArrayLike<any>

Returns a random permutation of elements in arr.

param

array-like object to shuffle

param

function options

param

string indicating whether to return a copy (deep, shallow, or none)

throws

must provide valid options

returns

the shuffled array-like object

Type declaration

Variables

Export assignment shuffle

shuffle: Shuffle

Returns a random permutation of elements in arr.

param

array-like object to shuffle

param

function options

param

string indicating whether to return a copy (deep, shallow, or none; default: 'shallow')

throws

must provide valid options

returns

the shuffled array-like object