Skip to content

Commit 9f848ed

Browse files
kgrytekgryte
committed
docs: rename parameter
1 parent 799e2b9 commit 9f848ed

File tree

2 files changed

+25
-25
lines changed

2 files changed

+25
-25
lines changed

‎lib/node_modules/@stdlib/wasm/base/array2dtype/docs/types/index.d.ts‎

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ import { RealOrComplexTypedArray, Complex128Array, Complex64Array, BooleanArray,
2525
/**
2626
* Returns the WebAssembly data type for a provided array.
2727
*
28-
* @param value - input value
28+
* @param array - input value
2929
* @returns data type
3030
*
3131
* @example
@@ -38,12 +38,12 @@ import { RealOrComplexTypedArray, Complex128Array, Complex64Array, BooleanArray,
3838
* var dt = array2dtype( [ 1, 2, 3 ] );
3939
* // returns 'float64'
4040
*/
41-
declare function array2dtype( value: Float64Array | Array<any> ): 'float64';
41+
declare function array2dtype( array: Float64Array | Array<any> ): 'float64';
4242

4343
/**
4444
* Returns the WebAssembly data type for a provided array.
4545
*
46-
* @param value - input value
46+
* @param array - input value
4747
* @returns data type
4848
*
4949
* @example
@@ -52,12 +52,12 @@ declare function array2dtype( value: Float64Array | Array<any> ): 'float64';
5252
* var dt = array2dtype( new Float32Array( [ 1, 2, 3 ] ) );
5353
* // returns 'float32'
5454
*/
55-
declare function array2dtype( value: Float32Array ): 'float32';
55+
declare function array2dtype( array: Float32Array ): 'float32';
5656

5757
/**
5858
* Returns the WebAssembly data type for a provided array.
5959
*
60-
* @param value - input value
60+
* @param array - input value
6161
* @returns data type
6262
*
6363
* @example
@@ -66,12 +66,12 @@ declare function array2dtype( value: Float32Array ): 'float32';
6666
* var dt = array2dtype( new Complex128Array( [ 1, 2, 3, 4 ] ) );
6767
* // returns 'complex128'
6868
*/
69-
declare function array2dtype( value: Complex128Array ): 'complex128';
69+
declare function array2dtype( array: Complex128Array ): 'complex128';
7070

7171
/**
7272
* Returns the WebAssembly data type for a provided array.
7373
*
74-
* @param value - input value
74+
* @param array - input value
7575
* @returns data type
7676
*
7777
* @example
@@ -80,12 +80,12 @@ declare function array2dtype( value: Complex128Array ): 'complex128';
8080
* var dt = array2dtype( new Complex64Array( [ 1, 2, 3, 4 ] ) );
8181
* // returns 'complex64'
8282
*/
83-
declare function array2dtype( value: Complex64Array ): 'complex64';
83+
declare function array2dtype( array: Complex64Array ): 'complex64';
8484

8585
/**
8686
* Returns the WebAssembly data type for a provided array.
8787
*
88-
* @param value - input value
88+
* @param array - input value
8989
* @returns data type
9090
*
9191
* @example
@@ -94,12 +94,12 @@ declare function array2dtype( value: Complex64Array ): 'complex64';
9494
* var dt = array2dtype( new Int32Array( [ 1, 2, 3 ] ) );
9595
* // returns 'int32'
9696
*/
97-
declare function array2dtype( value: Int32Array ): 'int32';
97+
declare function array2dtype( array: Int32Array ): 'int32';
9898

9999
/**
100100
* Returns the WebAssembly data type for a provided array.
101101
*
102-
* @param value - input value
102+
* @param array - input value
103103
* @returns data type
104104
*
105105
* @example
@@ -108,12 +108,12 @@ declare function array2dtype( value: Int32Array ): 'int32';
108108
* var dt = array2dtype( new Int16Array( [ 1, 2, 3 ] ) );
109109
* // returns 'int16'
110110
*/
111-
declare function array2dtype( value: Int16Array ): 'int16';
111+
declare function array2dtype( array: Int16Array ): 'int16';
112112

113113
/**
114114
* Returns the WebAssembly data type for a provided array.
115115
*
116-
* @param value - input value
116+
* @param array - input value
117117
* @returns data type
118118
*
119119
* @example
@@ -122,12 +122,12 @@ declare function array2dtype( value: Int16Array ): 'int16';
122122
* var dt = array2dtype( new Int8Array( [ 1, 2, 3 ] ) );
123123
* // returns 'int8'
124124
*/
125-
declare function array2dtype( value: Int8Array ): 'int8';
125+
declare function array2dtype( array: Int8Array ): 'int8';
126126

127127
/**
128128
* Returns the WebAssembly data type for a provided array.
129129
*
130-
* @param value - input value
130+
* @param array - input value
131131
* @returns data type
132132
*
133133
* @example
@@ -136,12 +136,12 @@ declare function array2dtype( value: Int8Array ): 'int8';
136136
* var dt = array2dtype( new Uint32Array( [ 1, 2, 3 ] ) );
137137
* // returns 'uint32'
138138
*/
139-
declare function array2dtype( value: Uint32Array ): 'uint32';
139+
declare function array2dtype( array: Uint32Array ): 'uint32';
140140

141141
/**
142142
* Returns the WebAssembly data type for a provided array.
143143
*
144-
* @param value - input value
144+
* @param array - input value
145145
* @returns data type
146146
*
147147
* @example
@@ -150,12 +150,12 @@ declare function array2dtype( value: Uint32Array ): 'uint32';
150150
* var dt = array2dtype( new Uint16Array( [ 1, 2, 3 ] ) );
151151
* // returns 'uint16'
152152
*/
153-
declare function array2dtype( value: Uint16Array ): 'uint16';
153+
declare function array2dtype( array: Uint16Array ): 'uint16';
154154

155155
/**
156156
* Returns the WebAssembly data type for a provided array.
157157
*
158-
* @param value - input value
158+
* @param array - input value
159159
* @returns data type
160160
*
161161
* @example
@@ -176,7 +176,7 @@ declare function array2dtype( value: Uint16Array ): 'uint16';
176176
* var dt = array2dtype( new BooleanArray( [ true, false, true, false ] ) );
177177
* // returns 'uint8'
178178
*/
179-
declare function array2dtype( value: Uint8Array | Uint8ClampedArray | BooleanArray ): 'uint8';
179+
declare function array2dtype( array: Uint8Array | Uint8ClampedArray | BooleanArray ): 'uint8';
180180

181181
/**
182182
* Returns the WebAssembly data type for a provided array.
@@ -185,7 +185,7 @@ declare function array2dtype( value: Uint8Array | Uint8ClampedArray | BooleanArr
185185
*
186186
* - If provided an argument having an unknown or unsupported type, the function assumes that the values can be stored as double-precision floating-point numbers and returns `'float64'`.
187187
*
188-
* @param value - input value
188+
* @param array - input value
189189
* @returns data type
190190
*
191191
* @example
@@ -195,7 +195,7 @@ declare function array2dtype( value: Uint8Array | Uint8ClampedArray | BooleanArr
195195
* var dt = array2dtype( 'beep' );
196196
* // returns 'float64'
197197
*/
198-
declare function array2dtype( value: Array<any> | RealOrComplexTypedArray | AccessorArrayLike<any> ): DataType;
198+
declare function array2dtype( array: Array<any> | RealOrComplexTypedArray | AccessorArrayLike<any> ): DataType;
199199

200200

201201
// EXPORTS //

‎lib/node_modules/@stdlib/wasm/base/array2dtype/lib/main.js‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ var dtype2wasm = require( '@stdlib/wasm/base/dtype2wasm' );
2929
/**
3030
* Returns the WebAssembly data type for a provided array.
3131
*
32-
* @param {Collection} values - input array
32+
* @param {Collection} array - input array
3333
* @returns {string} data type
3434
*
3535
* @example
@@ -48,8 +48,8 @@ var dtype2wasm = require( '@stdlib/wasm/base/dtype2wasm' );
4848
* var dt = array2dtype( new Float32Array( 4 ) );
4949
* // returns 'float32'
5050
*/
51-
function array2dtype( values ) {
52-
return dtype2wasm( dtype( values ) || 'generic' );
51+
function array2dtype( array ) {
52+
return dtype2wasm( dtype( array ) || 'generic' );
5353
}
5454

5555

0 commit comments

Comments
 (0)