From 81dd42f5462443389a1ae3af7415e415f7ff3f38 Mon Sep 17 00:00:00 2001 From: kgryte <2643044+kgryte@users.noreply.github.com> Date: Thu, 22 Feb 2024 21:34:56 +0000 Subject: [PATCH] feat: update namespace TypeScript declarations Signed-off-by: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com> --- .../@stdlib/array/docs/types/index.d.ts | 49 +++++-------------- 1 file changed, 11 insertions(+), 38 deletions(-) diff --git a/lib/node_modules/@stdlib/array/docs/types/index.d.ts b/lib/node_modules/@stdlib/array/docs/types/index.d.ts index 67eb0c61e31..78fe7f80568 100644 --- a/lib/node_modules/@stdlib/array/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/array/docs/types/index.d.ts @@ -453,12 +453,6 @@ interface Namespace { /** * Creates an uninitialized array having a specified length. * - * ## Notes - * - * - In browser environments, the function always returns zero-filled arrays. - * - If `dtype` is `'generic'`, the function always returns a zero-filled array. - * - In Node.js versions `>=3.0.0`, the underlying memory of returned typed arrays is **not** initialized. Memory contents are unknown and may contain **sensitive** data. - * * The function recognizes the following data types: * * - `float64`: double-precision floating-point numbers (IEEE 754) @@ -474,6 +468,12 @@ interface Namespace { * - `uint8c`: 8-bit unsigned integers clamped to `0-255` * - `generic`: generic JavaScript values * + * ## Notes + * + * - In browser environments, the function always returns zero-filled arrays. + * - If `dtype` is `'generic'`, the function always returns a zero-filled array. + * - In Node.js versions `>=3.0.0`, the underlying memory of returned typed arrays is **not** initialized. Memory contents are unknown and may contain **sensitive** data. + * * @param length - array length * @param dtype - data type (default: 'float64') * @returns empty array @@ -489,7 +489,7 @@ interface Namespace { empty: typeof empty; /** - * Creates an uninitialized array having the same length and data type as a provided input array. + * Creates an uninitialized array having the same length as a provided input array. * * ## Notes * @@ -519,20 +519,11 @@ interface Namespace { * @example * var zeros = require( '@stdlib/array/zeros' ); * - * var x = zeros( 2, 'float32' ); - * // returns [ 0.0, 0.0 ] - * - * var arr = ns.emptyLike( x ); - * // returns - * - * @example - * var zeros = require( '@stdlib/array/zeros' ); - * * var x = zeros( 2, 'float64' ); * // returns [ 0.0, 0.0 ] * - * var arr = ns.emptyLike( x ); - * // returns + * var arr = ns.emptyLike( x, 'float32' ); + * // returns */ emptyLike: typeof emptyLike; @@ -1040,7 +1031,7 @@ interface Namespace { ones: typeof ones; /** - * Creates an array filled with ones and having the same length and data type as a provided input array. + * Creates an array filled with ones and having the same length as a provided input array. * * The function supports the following data types: * @@ -1067,15 +1058,6 @@ interface Namespace { * var x = zeros( 2, 'float64' ); * // returns [ 0.0, 0.0 ] * - * var y = ns.onesLike( x ); - * // returns [ 1.0, 1.0 ] - * - * @example - * var zeros = require( '@stdlib/array/zeros' ); - * - * var x = zeros( 2, 'float64' ); - * // returns [ 0.0, 0.0 ] - * * var y = ns.onesLike( x, 'float32' ); * // returns [ 1.0, 1.0 ] */ @@ -1892,7 +1874,7 @@ interface Namespace { zeros: typeof zeros; /** - * Creates a zero-filled array having the same length and data type as a provided input array. + * Creates a zero-filled array having the same length as a provided input array. * * The function supports the following data types: * @@ -1919,15 +1901,6 @@ interface Namespace { * var x = zeros( 2, 'float64' ); * // returns [ 0.0, 0.0 ] * - * var y = ns.zerosLike( x ); - * // returns [ 0.0, 0.0 ] - * - * @example - * var zeros = require( '@stdlib/array/zeros' ); - * - * var x = zeros( 2, 'float64' ); - * // returns [ 0.0, 0.0 ] - * * var y = ns.zerosLike( x, 'float32' ); * // returns [ 0.0, 0.0 ] */