docs: update REPL namespace documentation

PR-URL: #2444 Co-authored-by: Athan Reines <[email protected]> Reviewed-by: Athan Reines <[email protected]> Signed-off-by: stdlib-bot <[email protected]>
stdlib-js · Jun 23, 2024 · bfd5b70 · bfd5b70 · stdlib-bot · Jun 23, 2024
1 parent fbc42b4
commit bfd5b70
Show file tree

Hide file tree

Showing 10 changed files with 13 additions and 8 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
@@ -2568,7 +2568,7 @@ BooleanArray.BYTES_PER_ELEMENT,"var nbytes = BooleanArray.BYTES_PER_ELEMENT\n"
 BooleanArray.name,"var str = BooleanArray.name\n"
 BooleanArray.prototype.buffer,"var arr = new BooleanArray( 2 )\nvar buf = arr.buffer\n"
 BooleanArray.prototype.byteLength,"var arr = new BooleanArray( 10 )\nvar nbytes = arr.byteLength\n"
-BooleanArray.prototype.byteOffset,"var arr = new BooleanArray( 10 )\nvar offset = arr.byteOffset\nvar buf = new ArrayBuffer( 240 )\narr = new BooleanArray( buf, 64 )\noffset = arr.byteOffset\n"
+BooleanArray.prototype.byteOffset,"var arr = new BooleanArray( 10 )\nvar offset = arr.byteOffset\nvar buf = new ArrayBuffer( 240 );\narr = new BooleanArray( buf, 64 )\noffset = arr.byteOffset\n"
 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"
@@ -2577,6 +2577,7 @@ BooleanArray.prototype.findIndex,"function predicate( v ) { return v === true; }
 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.includes,"var arr = new BooleanArray( [ true, false, true, true, true ] )\nvar bool = arr.includes( true )\nbool = arr.includes( false, 3 )\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"

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,6 +2577,7 @@ 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.includes,"\nBooleanArray.prototype.includes( searchElement:boolean[, fromIndex:integer] )\n    Returns a boolean indicating whether an array includes a provided value.\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"

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,7 @@ 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.includes,"BooleanArray.prototype.includes( searchElement[, fromIndex] )"
 BooleanArray.prototype.indexOf,"BooleanArray.prototype.indexOf( searchElement[, fromIndex] )"
 BooleanArray.prototype.lastIndexOf,"BooleanArray.prototype.lastIndexOf( searchElement[, fromIndex] )"
 BooleanArray.prototype.map,"BooleanArray.prototype.map( clbk[, thisArg] )"

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,6 +2583,7 @@ 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.includes,"BooleanArray.prototype.includes( searchElement:boolean[, fromIndex: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] )"

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\%$