Skip to content

Commit 53f64c8

Browse files
stdlib-botkgryte
andauthored
feat: update array TypeScript declarations
PR-URL: #12098 Co-authored-by: Athan Reines <kgryte@gmail.com> Reviewed-by: Athan Reines <kgryte@gmail.com>
1 parent 31695e0 commit 53f64c8

1 file changed

Lines changed: 68 additions & 0 deletions

File tree

  • lib/node_modules/@stdlib/array/docs/types

lib/node_modules/@stdlib/array/docs/types/index.d.ts

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@ import empty = require( '@stdlib/array/empty' );
4141
import emptyLike = require( '@stdlib/array/empty-like' );
4242
import filled = require( '@stdlib/array/filled' );
4343
import filledBy = require( '@stdlib/array/filled-by' );
44+
import Float16Array = require( '@stdlib/array/float16' );
4445
import Float32Array = require( '@stdlib/array/float32' );
4546
import Float64Array = require( '@stdlib/array/float64' );
4647
import iterator2array = require( '@stdlib/array/from-iterator' );
@@ -636,6 +637,73 @@ interface Namespace {
636637
*/
637638
filledBy: typeof filledBy;
638639

640+
/**
641+
* Half-precision floating-point number array constructor.
642+
*
643+
* @param arg - length, typed array, array-like object, or buffer
644+
* @param byteOffset - byte offset (default: 0)
645+
* @param length - view length
646+
* @throws ArrayBuffer byte length must be a multiple of `2`
647+
* @throws if provided only a single argument, must provide a valid argument
648+
* @throws byte offset must be a nonnegative integer
649+
* @throws byte offset must be a multiple of `2`
650+
* @throws view length must be a positive multiple of `2`
651+
* @throws must provide sufficient memory to accommodate byte offset and view length requirements
652+
* @returns half-precision floating-point number array
653+
*
654+
* @example
655+
* var arr = new ns.Float16Array();
656+
* // returns <Float16Array>
657+
*
658+
* var len = arr.length;
659+
* // returns 0
660+
*
661+
* @example
662+
* var arr = new ns.Float16Array( 2 );
663+
* // returns <Float16Array>
664+
*
665+
* var len = arr.length;
666+
* // returns 2
667+
*
668+
* @example
669+
* var arr = new ns.Float16Array( [ 1.0, 2.0 ] );
670+
* // returns <Float16Array>
671+
*
672+
* var len = arr.length;
673+
* // returns 2
674+
*
675+
* @example
676+
* var ArrayBuffer = require( '@stdlib/array/buffer' );
677+
*
678+
* var buf = new ArrayBuffer( 16 );
679+
* var arr = new ns.Float16Array( buf );
680+
* // returns <Float16Array>
681+
*
682+
* var len = arr.length;
683+
* // returns 8
684+
*
685+
* @example
686+
* var ArrayBuffer = require( '@stdlib/array/buffer' );
687+
*
688+
* var buf = new ArrayBuffer( 16 );
689+
* var arr = new ns.Float16Array( buf, 8 );
690+
* // returns <Float16Array>
691+
*
692+
* var len = arr.length;
693+
* // returns 4
694+
*
695+
* @example
696+
* var ArrayBuffer = require( '@stdlib/array/buffer' );
697+
*
698+
* var buf = new ArrayBuffer( 32 );
699+
* var arr = new ns.Float16Array( buf, 8, 2 );
700+
* // returns <Float16Array>
701+
*
702+
* var len = arr.length;
703+
* // returns 2
704+
*/
705+
Float16Array: typeof Float16Array;
706+
639707
/**
640708
* Typed array constructor which returns a typed array representing an array of single-precision floating-point numbers in the platform byte order.
641709
*/

0 commit comments

Comments
 (0)