Skip to content

Commit 01c5959

Browse files
committed
feat: update array/base TypeScript declarations
Signed-off-by: stdlib-bot <[email protected]>
1 parent 5c3691e commit 01c5959

File tree

1 file changed

+11
-9
lines changed
  • lib/node_modules/@stdlib/array/base/docs/types

1 file changed

+11
-9
lines changed

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

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -742,7 +742,7 @@ interface Namespace {
742742
* var x = [ 'beep', 'boop', 'foo', 'bar' ];
743743
* var filter = [ true, true, false, true ];
744744
*
745-
* var out = ns.bifurcateEntries( arr, filter );
745+
* var out = ns.bifurcateEntries( x, filter );
746746
* // returns [ [ [ 0, 'beep' ], [ 1, 'boop' ], [ 3, 'bar' ] ], [ [ 2, 'foo' ] ] ]
747747
*/
748748
bifurcateEntries: typeof bifurcateEntries;
@@ -822,7 +822,7 @@ interface Namespace {
822822
* var x = [ 'beep', 'boop', 'foo', 'bar' ];
823823
* var filter = [ true, true, false, true ];
824824
*
825-
* var out = ns.bifurcateValues( arr, filter );
825+
* var out = ns.bifurcateValues( x, filter );
826826
* // returns [ [ 'beep', 'boop', 'bar' ], [ 'foo' ] ]
827827
*/
828828
bifurcateValues: typeof bifurcateValues;
@@ -2138,16 +2138,16 @@ interface Namespace {
21382138
*
21392139
* @example
21402140
* function fcn( v ) {
2141-
* return v > 0;
2141+
* return v > 0;
21422142
* }
21432143
* var x = [ 1, 1, 0, 0, 0 ];
21442144
*
2145-
* var result = cunoneByright( x, fcn );
2145+
* var result = ns.cunoneByRight( x, fcn );
21462146
* // returns [ true, true, true, false, false ]
21472147
*
21482148
* @example
21492149
* function fcn( v ) {
2150-
* return v > 0;
2150+
* return v > 0;
21512151
* }
21522152
* var x = [ 0, 1, 1, 0, 0 ];
21532153
* var y = [ false, null, false, null, false, null, false, null, false, null ];
@@ -2734,7 +2734,7 @@ interface Namespace {
27342734
* @example
27352735
* var arr = [ 1, 2, 3 ];
27362736
*
2737-
* var out = ns.first( x );
2737+
* var out = ns.first( arr );
27382738
* // returns 1
27392739
*/
27402740
first: typeof first;
@@ -3537,7 +3537,7 @@ interface Namespace {
35373537
* @example
35383538
* var arr = [ 1, 2, 3 ];
35393539
*
3540-
* var out = ns.last( x );
3540+
* var out = ns.last( arr );
35413541
* // returns 3
35423542
*/
35433543
last: typeof last;
@@ -4014,7 +4014,7 @@ interface Namespace {
40144014
*
40154015
* var mask = [ [ [ [ 0, 1 ], [ 0, 0 ] ] ] ];
40164016
*
4017-
* mskbinary2d( [ x, y, mask, z ], shape, add );
4017+
* ns.mskbinary4d( [ x, y, mask, z ], shape, add );
40184018
*
40194019
* console.log( z );
40204020
* // => [ [ [ [ 2.0, 0.0 ], [ 2.0, 2.0 ] ] ] ]
@@ -4946,6 +4946,8 @@ interface Namespace {
49464946
* @returns output array
49474947
*
49484948
* @example
4949+
* var isPositiveNumber = require( '@stdlib/assert/is-positive-number' ).isPrimitive;
4950+
*
49494951
* var x = [ 1, -2, -3, 4 ];
49504952
*
49514953
* var out = ns.reject( x, isPositiveNumber );
@@ -5976,7 +5978,7 @@ interface Namespace {
59765978
* var x = ones5d( shape );
59775979
* var y = zeros5d( shape );
59785980
*
5979-
* unary2dBy( [ x, y ], shape, scale );
5981+
* ns.unary5dBy( [ x, y ], shape, scale );
59805982
*
59815983
* console.log( y );
59825984
* // => [ [ [ [ [ -10.0, -10.0 ], [ -10.0, -10.0 ] ] ] ] ]

0 commit comments

Comments
 (0)