Skip to content

Commit a1d0481

Browse files
committed
Rename option parameeter
1 parent 5e8b511 commit a1d0481

File tree

1 file changed

+5
-5
lines changed
  • lib/node_modules/@stdlib/random/shuffle/docs/types

1 file changed

+5
-5
lines changed

lib/node_modules/@stdlib/random/shuffle/docs/types/index.d.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ interface Options {
3535
/**
3636
* Interface defining `factory` options.
3737
*/
38-
interface Config {
38+
interface FactoryOptions {
3939
/**
4040
* Default copy option (`deep`, `shallow`, or `none`; default: 'shallow')
4141
*/
@@ -102,9 +102,9 @@ interface Shuffle {
102102
/**
103103
* Returns a function to create a random permutation of elements from an array-like object.
104104
*
105-
* @param config - function options
106-
* @param config.seed - integer-valued seed
107-
* @param config.copy - default copy option (`deep`, `shallow`, or `none`; default: 'shallow')
105+
* @param options - function options
106+
* @param options.seed - integer-valued seed
107+
* @param options.copy - default copy option (`deep`, `shallow`, or `none`; default: 'shallow')
108108
* @throws must provide valid options
109109
* @returns shuffle function
110110
*
@@ -116,7 +116,7 @@ interface Shuffle {
116116
* var out = fcn( data );
117117
* // e.g., returns [ 4, 3, 8, 8 ]
118118
*/
119-
factory( config?: Config ): ShuffleFunction;
119+
factory( options?: FactoryOptions ): ShuffleFunction;
120120
}
121121

122122
/**

0 commit comments

Comments
 (0)