Skip to content

Commit 889f7b2

Browse files
authored
feat: update array TypeScript declarations
PR-URL: #11237 Reviewed-by: Athan Reines <kgryte@gmail.com>
1 parent eabc418 commit 889f7b2

File tree

1 file changed

+22
-0
lines changed
  • lib/node_modules/@stdlib/array/docs/types

1 file changed

+22
-0
lines changed

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

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,7 @@ import mskreject = require( '@stdlib/array/mskreject' );
6262
import nans = require( '@stdlib/array/nans' );
6363
import nansLike = require( '@stdlib/array/nans-like' );
6464
import nextDataType = require( '@stdlib/array/next-dtype' );
65+
import nulls = require( '@stdlib/array/nulls' );
6566
import oneTo = require( '@stdlib/array/one-to' );
6667
import oneToLike = require( '@stdlib/array/one-to-like' );
6768
import ones = require( '@stdlib/array/ones' );
@@ -1008,6 +1009,27 @@ interface Namespace {
10081009
*/
10091010
nextDataType: typeof nextDataType;
10101011

1012+
/**
1013+
* Creates an array filled with nulls and having a specified length.
1014+
*
1015+
* The function recognizes the following data types:
1016+
*
1017+
* - `generic`: generic JavaScript values
1018+
*
1019+
* @param length - array length
1020+
* @param dtype - data type (default: 'generic')
1021+
* @returns filled array
1022+
*
1023+
* @example
1024+
* var arr = ns.nulls( 2 );
1025+
* // returns [ null, null ]
1026+
*
1027+
* @example
1028+
* var arr = ns.nulls( 2, 'generic' );
1029+
* // returns [ null, null ]
1030+
*/
1031+
nulls: typeof nulls;
1032+
10111033
/**
10121034
* Generates a linearly spaced numeric array whose elements increment by 1 starting from one.
10131035
*

0 commit comments

Comments
 (0)