From ec8023299d729fc307d0547708189fd19409d3f8 Mon Sep 17 00:00:00 2001 From: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com> Date: Tue, 12 May 2026 03:17:35 +0000 Subject: [PATCH] feat: update `array` TypeScript declarations Signed-off-by: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com> --- .../@stdlib/array/docs/types/index.d.ts | 68 +++++++++++++++++++ 1 file changed, 68 insertions(+) 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 582c8788c674..f77856c81130 100644 --- a/lib/node_modules/@stdlib/array/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/array/docs/types/index.d.ts @@ -41,6 +41,7 @@ import empty = require( '@stdlib/array/empty' ); import emptyLike = require( '@stdlib/array/empty-like' ); import filled = require( '@stdlib/array/filled' ); import filledBy = require( '@stdlib/array/filled-by' ); +import Float16Array = require( '@stdlib/array/float16' ); import Float32Array = require( '@stdlib/array/float32' ); import Float64Array = require( '@stdlib/array/float64' ); import iterator2array = require( '@stdlib/array/from-iterator' ); @@ -636,6 +637,73 @@ interface Namespace { */ filledBy: typeof filledBy; + /** + * Half-precision floating-point number array constructor. + * + * @param arg - length, typed array, array-like object, or buffer + * @param byteOffset - byte offset (default: 0) + * @param length - view length + * @throws ArrayBuffer byte length must be a multiple of `2` + * @throws if provided only a single argument, must provide a valid argument + * @throws byte offset must be a nonnegative integer + * @throws byte offset must be a multiple of `2` + * @throws view length must be a positive multiple of `2` + * @throws must provide sufficient memory to accommodate byte offset and view length requirements + * @returns half-precision floating-point number array + * + * @example + * var arr = new ns.Float16Array(); + * // returns + * + * var len = arr.length; + * // returns 0 + * + * @example + * var arr = new ns.Float16Array( 2 ); + * // returns + * + * var len = arr.length; + * // returns 2 + * + * @example + * var arr = new ns.Float16Array( [ 1.0, 2.0 ] ); + * // returns + * + * var len = arr.length; + * // returns 2 + * + * @example + * var ArrayBuffer = require( '@stdlib/array/buffer' ); + * + * var buf = new ArrayBuffer( 16 ); + * var arr = new ns.Float16Array( buf ); + * // returns + * + * var len = arr.length; + * // returns 8 + * + * @example + * var ArrayBuffer = require( '@stdlib/array/buffer' ); + * + * var buf = new ArrayBuffer( 16 ); + * var arr = new ns.Float16Array( buf, 8 ); + * // returns + * + * var len = arr.length; + * // returns 4 + * + * @example + * var ArrayBuffer = require( '@stdlib/array/buffer' ); + * + * var buf = new ArrayBuffer( 32 ); + * var arr = new ns.Float16Array( buf, 8, 2 ); + * // returns + * + * var len = arr.length; + * // returns 2 + */ + Float16Array: typeof Float16Array; + /** * Typed array constructor which returns a typed array representing an array of single-precision floating-point numbers in the platform byte order. */