docs: update REPL namespace documentation

PR-URL: #2437 Co-authored-by: Athan Reines <[email protected]> Reviewed-by: Athan Reines <[email protected]> Signed-off-by: stdlib-bot <[email protected]>
stdlib-js · Jun 22, 2024 · 211c131 · 211c131 · stdlib-bot · Jun 22, 2024
1 parent ad36a03
commit 211c131
Show file tree

Hide file tree

Showing 10 changed files with 33 additions and 23 deletions.
diff --git a/lib/node_modules/@stdlib/repl/code-blocks/data/data.csv b/lib/node_modules/@stdlib/repl/code-blocks/data/data.csv
@@ -2572,18 +2572,20 @@ BooleanArray.prototype.byteOffset,"var arr = new BooleanArray( 10 )\nvar offset
 BooleanArray.prototype.BYTES_PER_ELEMENT,"var arr = new BooleanArray( 10 )\narr.BYTES_PER_ELEMENT\n"
 BooleanArray.prototype.length,"var arr = new BooleanArray( 10 )\nvar len = arr.length\n"
 BooleanArray.prototype.every,"function predicate( v ) { return v === true; };\nvar arr = new BooleanArray( [ true, true, true ] )\nvar bool = arr.every( predicate )\n"
-BooleanArray.prototype.find,"function predicate( v ) { return v === true; }\nvar arr = new BooleanArray( [ true, false, true ] )\nvar v = arr.find( predicate )\n"
-BooleanArray.prototype.findIndex,"function predicate( v ) { return v === true; }\nvar arr = new BooleanArray( [ true, false, true ] )\nvar idx = arr.findIndex( predicate )\n"
-BooleanArray.prototype.findLast,"function predicate( v ) { return v === true; }\nvar arr = new BooleanArray( [ true, false, true ] )\nvar v = arr.findLast( predicate )\n"
-BooleanArray.prototype.findLastIndex,"function predicate( v ) { return v === true; }\nvar arr = new BooleanArray( [ true, false, true ] )\nvar idx = arr.findLastIndex( predicate )\n"
+BooleanArray.prototype.find,"function predicate( v ) { return v === true; };\nvar arr = new BooleanArray( [ true, false, true ] )\nvar v = arr.find( predicate )\n"
+BooleanArray.prototype.findIndex,"function predicate( v ) { return v === true; };\nvar arr = new BooleanArray( [ true, false, true ] )\nvar idx = arr.findIndex( predicate )\n"
+BooleanArray.prototype.findLast,"function predicate( v ) { return v === true; };\nvar arr = new BooleanArray( [ true, false, true ] )\nvar v = arr.findLast( predicate )\n"
+BooleanArray.prototype.findLastIndex,"function predicate( v ) { return v === true; };\nvar arr = new BooleanArray( [ true, false, true ] )\nvar idx = arr.findLastIndex( predicate )\n"
 BooleanArray.prototype.get,"var arr = new BooleanArray( 10 )\narr.set( true, 0 );\nvar v = arr.get( 0 )\n"
-BooleanArray.prototype.map,"function invert( v ) { return !v; }\nvar arr = new BooleanArray( [ true, false, true ] )\nvar out = arr.map( invert )\nvar v = out.get( 0 )\nv = out.get( 1 )\nv = out.get( 2 )\n"
+BooleanArray.prototype.indexOf,"var arr = new BooleanArray( [ true, false, true, true, true ] )\nvar idx = arr.indexOf( true )\nidx = arr.indexOf( false, 3 )\n"
+BooleanArray.prototype.lastIndexOf,"var arr = new BooleanArray( [ true, true, true, false, true ] )\nvar idx = arr.lastIndexOf( false )\nidx = arr.lastIndexOf( false, 2 )\n"
+BooleanArray.prototype.map,"function invert( v ) { return !v; };\nvar arr = new BooleanArray( [ true, false, true ] )\nvar out = arr.map( invert )\nvar v = out.get( 0 )\nv = out.get( 1 )\nv = out.get( 2 )\n"
 BooleanArray.prototype.reverse,"var arr = new BooleanArray( [ true, false, false ] )\narr.reverse();\nvar v = arr.get( 0 )\nv = arr.get( 1 )\nv = arr.get( 2 )\n"
 BooleanArray.prototype.set,"var arr = new BooleanArray( 2 )\narr.set( false );\nvar v = arr.get( 0 )\narr.set( true, 1 );\nv = arr.get( 1 )\n"
 BooleanArray.prototype.some,"function predicate( v ) { return v === true; };\nvar arr = new BooleanArray( [ false, true, false ] )\nvar bool = arr.some( predicate )\n"
-BooleanArray.prototype.sort,"function compare( a, b ) { return a === true ? -1 : 1; }\nvar arr = new BooleanArray( [ true, false, true ] )\narr.sort( compare );\nvar v = arr.get( 0 )\nv = arr.get( 1 )\nv = arr.get( 2 )\n"
+BooleanArray.prototype.sort,"function compare( a, b ) { return a === true ? -1 : 1; };\nvar arr = new BooleanArray( [ true, false, true ] )\narr.sort( compare );\nvar v = arr.get( 0 )\nv = arr.get( 1 )\nv = arr.get( 2 )\n"
 BooleanArray.prototype.toReversed,"var arr = new BooleanArray( [ true, false, false ] )\nvar out = arr.toReversed()\nvar v = out.get( 0 )\nv = out.get( 1 )\nv = out.get( 2 )\n"
-BooleanArray.prototype.toSorted,"function compare( a, b ) { return a === true ? -1 : 1; }\nvar arr = new BooleanArray( [ true, false, true ] )\nvar out = arr.toSorted( compare );\nvar v = out.get( 0 )\nv = out.get( 1 )\nv = out.get( 2 )\n"
+BooleanArray.prototype.toSorted,"function compare( a, b ) { return a === true ? -1 : 1; };\nvar arr = new BooleanArray( [ true, false, true ] )\nvar out = arr.toSorted( compare );\nvar v = out.get( 0 )\nv = out.get( 1 )\nv = out.get( 2 )\n"
 broadcastArray,"var x = array( [ [ 1, 2 ], [ 3, 4 ] ] )\nvar sh = x.shape\nvar y = broadcastArray( x, [ 3, 2, 2 ] )\nsh = y.shape\nvar v = y.get( 0, 0, 0 )\nv = y.get( 0, 0, 1 )\nv = y.get( 0, 1, 0 )\nv = y.get( 0, 1, 1 )\nv = y.get( 1, 0, 0 )\nv = y.get( 1, 1, 0 )\nv = y.get( 2, 0, 0 )\nv = y.get( 2, 1, 1 )\n"
 broadcastArrays,"var x = array( [ [ 1, 2 ], [ 3, 4 ] ] )\nvar sh = x.shape\nvar y = ndzeros( [ 3, 2, 2 ] )\nvar out = broadcastArrays( [ x, y ] )\nvar bx = out[ 0 ]\nsh = bx.shape\nvar v = bx.get( 0, 0, 0 )\nv = bx.get( 0, 0, 1 )\nv = bx.get( 0, 1, 0 )\nv = bx.get( 0, 1, 1 )\nv = bx.get( 1, 0, 0 )\nv = bx.get( 1, 1, 0 )\nv = bx.get( 2, 0, 0 )\nv = bx.get( 2, 1, 1 )\n"
 Buffer,"var b = new Buffer( 4 )\nvar b1 = new Buffer( [ 1, 2, 3, 4 ] );\nvar b2 = new Buffer( b1 )\nvar b = new Buffer( [ 1, 2, 3, 4 ] )\nvar b = new Buffer( 'beep boop' )\n"

diff --git a/lib/node_modules/@stdlib/repl/code-blocks/data/data.json b/lib/node_modules/@stdlib/repl/code-blocks/data/data.json
diff --git a/lib/node_modules/@stdlib/repl/help/data/data.csv b/lib/node_modules/@stdlib/repl/help/data/data.csv
diff --git a/lib/node_modules/@stdlib/repl/help/data/data.json b/lib/node_modules/@stdlib/repl/help/data/data.json
diff --git a/lib/node_modules/@stdlib/repl/info/data/data.csv b/lib/node_modules/@stdlib/repl/info/data/data.csv
@@ -2577,10 +2577,12 @@ BooleanArray.prototype.findIndex,"\nBooleanArray.prototype.findIndex( predicate:
 BooleanArray.prototype.findLast,"\nBooleanArray.prototype.findLast( predicate:Function[, thisArg:Any] )\n    Returns the last element in an array for which a predicate function returns\n    a truthy value.\n"
 BooleanArray.prototype.findLastIndex,"\nBooleanArray.prototype.findLastIndex( predicate:Function[, thisArg:Any] )\n    Returns the index of the last element in an array for which a predicate\n    function returns a truthy value.\n"
 BooleanArray.prototype.get,"\nBooleanArray.prototype.get( i:integer )\n    Returns an array element located at integer position (index) `i`.\n"
+BooleanArray.prototype.indexOf,"\nBooleanArray.prototype.indexOf( searchElement:boolean[, fromIndex:integer] )\n    Returns the first index at which a given element can be found.\n"
+BooleanArray.prototype.lastIndexOf,"\nBooleanArray.prototype.lastIndexOf( searchElement:boolean[, fromIndex:integer] )\n    Returns the last index at which a given element can be found.\n"
 BooleanArray.prototype.map,"\nBooleanArray.prototype.map( clbk:Function[, thisArg:Any] )\n    Returns a new array with each element being the result of a provided\n    callback function.\n"
 BooleanArray.prototype.reverse,"\nBooleanArray.prototype.reverse()\n    Reverses the array *in-place*.\n"
 BooleanArray.prototype.set,"\nBooleanArray.prototype.set( v:bool|BooleanArray|ArrayLikeObject[, i:integer] )\n    Sets one or more array elements.\n"
-BooleanArray.prototype.some,"\nBooleanArray.prototype.some( predicate[, thisArg] )\n    Returns a boolean indicating whether at least one element passes a test.\n"
+BooleanArray.prototype.some,"\nBooleanArray.prototype.some( predicate:Function[, thisArg:Any] )\n    Returns a boolean indicating whether at least one element passes a test.\n"
 BooleanArray.prototype.sort,"\nBooleanArray.prototype.sort( [compareFunction:Function] )\n    Sorts an array in-place.\n"
 BooleanArray.prototype.toReversed,"\nBooleanArray.prototype.toReversed()\n    Returns a new typed array containing the elements in reversed order.\n"
 BooleanArray.prototype.toSorted,"\nBooleanArray.prototype.toSorted( [compareFunction:Function] )\n    Returns a new typed array containing the elements in sorted order.\n"

diff --git a/lib/node_modules/@stdlib/repl/info/data/data.json b/lib/node_modules/@stdlib/repl/info/data/data.json
diff --git a/lib/node_modules/@stdlib/repl/signature/data/data.csv b/lib/node_modules/@stdlib/repl/signature/data/data.csv
@@ -2583,6 +2583,8 @@ BooleanArray.prototype.findIndex,"BooleanArray.prototype.findIndex( predicate[,
 BooleanArray.prototype.findLast,"BooleanArray.prototype.findLast( predicate[, thisArg] )"
 BooleanArray.prototype.findLastIndex,"BooleanArray.prototype.findLastIndex( predicate[, thisArg] )"
 BooleanArray.prototype.get,"BooleanArray.prototype.get( i )"
+BooleanArray.prototype.indexOf,"BooleanArray.prototype.indexOf( searchElement[, fromIndex] )"
+BooleanArray.prototype.lastIndexOf,"BooleanArray.prototype.lastIndexOf( searchElement[, fromIndex] )"
 BooleanArray.prototype.map,"BooleanArray.prototype.map( clbk[, thisArg] )"
 BooleanArray.prototype.reverse,"BooleanArray.prototype.reverse()"
 BooleanArray.prototype.set,"BooleanArray.prototype.set( v[, i] )"

diff --git a/lib/node_modules/@stdlib/repl/signature/data/data.json b/lib/node_modules/@stdlib/repl/signature/data/data.json
diff --git a/lib/node_modules/@stdlib/repl/typed-signature/data/data.csv b/lib/node_modules/@stdlib/repl/typed-signature/data/data.csv
@@ -2583,10 +2583,12 @@ BooleanArray.prototype.findIndex,"BooleanArray.prototype.findIndex( predicate:Fu
 BooleanArray.prototype.findLast,"BooleanArray.prototype.findLast( predicate:Function[, thisArg:Any] )"
 BooleanArray.prototype.findLastIndex,"BooleanArray.prototype.findLastIndex( predicate:Function[, thisArg:Any] )"
 BooleanArray.prototype.get,"BooleanArray.prototype.get( i:integer )"
+BooleanArray.prototype.indexOf,"BooleanArray.prototype.indexOf( searchElement:boolean[, fromIndex:integer] )"
+BooleanArray.prototype.lastIndexOf,"BooleanArray.prototype.lastIndexOf( searchElement:boolean[, fromIndex:integer] )"
 BooleanArray.prototype.map,"BooleanArray.prototype.map( clbk:Function[, thisArg:Any] )"
 BooleanArray.prototype.reverse,"BooleanArray.prototype.reverse()"
 BooleanArray.prototype.set,"BooleanArray.prototype.set( v:bool|BooleanArray|ArrayLikeObject[, i:integer] )"
-BooleanArray.prototype.some,"BooleanArray.prototype.some( predicate[, thisArg] )"
+BooleanArray.prototype.some,"BooleanArray.prototype.some( predicate:Function[, thisArg:Any] )"
 BooleanArray.prototype.sort,"BooleanArray.prototype.sort( [compareFunction:Function] )"
 BooleanArray.prototype.toReversed,"BooleanArray.prototype.toReversed()"
 BooleanArray.prototype.toSorted,"BooleanArray.prototype.toSorted( [compareFunction:Function] )"

diff --git a/lib/node_modules/@stdlib/repl/typed-signature/data/data.json b/lib/node_modules/@stdlib/repl/typed-signature/data/data.json
Package	Statements	Branches	Functions	Lines
repl/code-blocks	$\color{green}95/95$ $\color{green}+100.00\%$	$\color{green}7/7$ $\color{green}+100.00\%$	$\color{green}1/1$ $\color{green}+100.00\%$	$\color{green}95/95$ $\color{green}+100.00\%$
repl/help	$\color{green}95/95$ $\color{green}+100.00\%$	$\color{green}7/7$ $\color{green}+100.00\%$	$\color{green}1/1$ $\color{green}+100.00\%$	$\color{green}95/95$ $\color{green}+100.00\%$
repl/info	$\color{green}95/95$ $\color{green}+100.00\%$	$\color{green}7/7$ $\color{green}+100.00\%$	$\color{green}1/1$ $\color{green}+100.00\%$	$\color{green}95/95$ $\color{green}+100.00\%$
repl/signature	$\color{green}99/99$ $\color{green}+100.00\%$	$\color{green}10/10$ $\color{green}+100.00\%$	$\color{green}1/1$ $\color{green}+100.00\%$	$\color{green}99/99$ $\color{green}+100.00\%$
repl/typed-signature	$\color{green}99/99$ $\color{green}+100.00\%$	$\color{green}10/10$ $\color{green}+100.00\%$	$\color{green}1/1$ $\color{green}+100.00\%$	$\color{green}99/99$ $\color{green}+100.00\%$