Skip to content

Commit 6a106fb

Browse files
stdlib-botkgryte
andauthored
docs: update REPL namespace documentation
PR-URL: #2592 Co-authored-by: Athan Reines <kgryte@gmail.com> Reviewed-by: Athan Reines <kgryte@gmail.com> Signed-off-by: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com>
1 parent a360f04 commit 6a106fb

File tree

10 files changed

+22
-7
lines changed

10 files changed

+22
-7
lines changed

lib/node_modules/@stdlib/repl/code-blocks/data/data.csv

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2580,6 +2580,7 @@ BooleanArray.prototype.get,"var arr = new BooleanArray( 10 )\narr.set( true, 0 )
25802580
BooleanArray.prototype.includes,"var arr = new BooleanArray( [ true, false, true, true, true ] )\nvar bool = arr.includes( true )\nbool = arr.includes( false, 3 )\n"
25812581
BooleanArray.prototype.indexOf,"var arr = new BooleanArray( [ true, false, true, true, true ] )\nvar idx = arr.indexOf( true )\nidx = arr.indexOf( false, 3 )\n"
25822582
BooleanArray.prototype.join,"var arr = new BooleanArray( [ true, false, true ] )\nvar str = arr.join()\nstr = arr.join( '|' )\n"
2583+
BooleanArray.prototype.keys,"var arr = new BooleanArray( [ true, false ] )\nvar it = arr.keys();\nvar v = it.next().value\nv = it.next().value\nv = it.next().done\n"
25832584
BooleanArray.prototype.lastIndexOf,"var arr = new BooleanArray( [ true, true, true, false, true ] )\nvar idx = arr.lastIndexOf( false )\nidx = arr.lastIndexOf( false, 2 )\n"
25842585
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"
25852586
BooleanArray.prototype.reduce,"function reducer( acc, v ) { return ( acc && v ); };\nvar arr = new BooleanArray( [ true, false, true ] )\nvar out = arr.reduce( reducer )\n"
@@ -2593,6 +2594,8 @@ BooleanArray.prototype.subarray,"var arr = new BooleanArray( [ true, false, true
25932594
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"
25942595
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"
25952596
BooleanArray.prototype.toString,"var arr = new BooleanArray( [ true, false, true ] )\nvar str = arr.toString()\n"
2597+
BooleanArray.prototype.values,"var arr = new BooleanArray( [ true, false ] )\nvar it = arr.values();\nvar v = it.next().value\nv = it.next().value\nvar bool = it.next().done\n"
2598+
BooleanArray.prototype.with,"var arr = new BooleanArray( [ true, false, true ] )\nvar out = arr.with( 0, false )\nvar v = out.get( 0 )\n"
25962599
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"
25972600
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"
25982601
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"

lib/node_modules/@stdlib/repl/code-blocks/data/data.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

lib/node_modules/@stdlib/repl/help/data/data.csv

Lines changed: 5 additions & 2 deletions
Large diffs are not rendered by default.

lib/node_modules/@stdlib/repl/help/data/data.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

lib/node_modules/@stdlib/repl/info/data/data.csv

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2580,6 +2580,7 @@ BooleanArray.prototype.get,"\nBooleanArray.prototype.get( i:integer )\n Retur
25802580
BooleanArray.prototype.includes,"\nBooleanArray.prototype.includes( searchElement:boolean[, fromIndex:integer] )\n Returns a boolean indicating whether an array includes a provided value.\n"
25812581
BooleanArray.prototype.indexOf,"\nBooleanArray.prototype.indexOf( searchElement:boolean[, fromIndex:integer] )\n Returns the first index at which a given element can be found.\n"
25822582
BooleanArray.prototype.join,"\nBooleanArray.prototype.join( [separator:string] )\n Returns a new string by concatenating all array elements separated by a\n separator string.\n"
2583+
BooleanArray.prototype.keys,"\nBooleanArray.prototype.keys()\n Returns an iterator for iterating over each index key in a typed array.\n"
25832584
BooleanArray.prototype.lastIndexOf,"\nBooleanArray.prototype.lastIndexOf( searchElement:boolean[, fromIndex:integer] )\n Returns the last index at which a given element can be found.\n"
25842585
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"
25852586
BooleanArray.prototype.reduce,"\nBooleanArray.prototype.reduce( reducerFn:Function[, initialValue:any] )\n Applies a provided function to each element of the array, in order, passing\n in the return value from the calculation on the preceding element and\n returning the accumulated result upon completion.\n"
@@ -2593,6 +2594,8 @@ BooleanArray.prototype.subarray,"\nBooleanArray.prototype.subarray( [begin:integ
25932594
BooleanArray.prototype.toReversed,"\nBooleanArray.prototype.toReversed()\n Returns a new typed array containing the elements in reversed order.\n"
25942595
BooleanArray.prototype.toSorted,"\nBooleanArray.prototype.toSorted( [compareFunction:Function] )\n Returns a new typed array containing the elements in sorted order.\n"
25952596
BooleanArray.prototype.toString,"\nBooleanArray.prototype.toString()\n Serializes an array as a string.\n"
2597+
BooleanArray.prototype.values,"\nBooleanArray.prototype.values()\n Returns an iterator for iterating over each value in a typed array.\n"
2598+
BooleanArray.prototype.with,"\nBooleanArray.prototype.with( index, value )\n Returns a new typed array with the element at a provided index replaced\n with a provided value.\n"
25962599
broadcastArray,"\nbroadcastArray( x:ndarray, shape:ArrayLikeObject )\n Broadcasts an ndarray to a specified shape.\n"
25972600
broadcastArrays,"\nbroadcastArrays( ...arrays:ndarray|ArrayLikeObject<ndarray> )\n Broadcasts ndarrays to a common shape.\n"
25982601
Buffer,"\nBuffer\n\nBuffer( size:integer )\n Allocates a buffer having a specified number of bytes.\n\nBuffer( buffer:Buffer )\n Copies buffer data to a new Buffer instance.\n\nBuffer( array:Array )\n Allocates a buffer using an array of octets.\n\nBuffer( str:string[, encoding:string] )\n Allocates a buffer containing a provided string.\n"

lib/node_modules/@stdlib/repl/info/data/data.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

lib/node_modules/@stdlib/repl/signature/data/data.csv

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2586,6 +2586,7 @@ BooleanArray.prototype.get,"BooleanArray.prototype.get( i )"
25862586
BooleanArray.prototype.includes,"BooleanArray.prototype.includes( searchElement[, fromIndex] )"
25872587
BooleanArray.prototype.indexOf,"BooleanArray.prototype.indexOf( searchElement[, fromIndex] )"
25882588
BooleanArray.prototype.join,"BooleanArray.prototype.join( [separator] )"
2589+
BooleanArray.prototype.keys,"BooleanArray.prototype.keys()"
25892590
BooleanArray.prototype.lastIndexOf,"BooleanArray.prototype.lastIndexOf( searchElement[, fromIndex] )"
25902591
BooleanArray.prototype.map,"BooleanArray.prototype.map( clbk[, thisArg] )"
25912592
BooleanArray.prototype.reduce,"BooleanArray.prototype.reduce( reducerFn[, initialValue] )"
@@ -2599,6 +2600,8 @@ BooleanArray.prototype.subarray,"BooleanArray.prototype.subarray( [begin[, end]]
25992600
BooleanArray.prototype.toReversed,"BooleanArray.prototype.toReversed()"
26002601
BooleanArray.prototype.toSorted,"BooleanArray.prototype.toSorted( [compareFunction] )"
26012602
BooleanArray.prototype.toString,"BooleanArray.prototype.toString()"
2603+
BooleanArray.prototype.values,"BooleanArray.prototype.values()"
2604+
BooleanArray.prototype.with,"BooleanArray.prototype.with( index, value )"
26022605
broadcastArray,"broadcastArray( x, shape )"
26032606
broadcastArrays,"broadcastArrays( ...arrays )"
26042607
Buffer,"Buffer"

lib/node_modules/@stdlib/repl/signature/data/data.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

lib/node_modules/@stdlib/repl/typed-signature/data/data.csv

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2586,6 +2586,7 @@ BooleanArray.prototype.get,"BooleanArray.prototype.get( i:integer )"
25862586
BooleanArray.prototype.includes,"BooleanArray.prototype.includes( searchElement:boolean[, fromIndex:integer] )"
25872587
BooleanArray.prototype.indexOf,"BooleanArray.prototype.indexOf( searchElement:boolean[, fromIndex:integer] )"
25882588
BooleanArray.prototype.join,"BooleanArray.prototype.join( [separator:string] )"
2589+
BooleanArray.prototype.keys,"BooleanArray.prototype.keys()"
25892590
BooleanArray.prototype.lastIndexOf,"BooleanArray.prototype.lastIndexOf( searchElement:boolean[, fromIndex:integer] )"
25902591
BooleanArray.prototype.map,"BooleanArray.prototype.map( clbk:Function[, thisArg:Any] )"
25912592
BooleanArray.prototype.reduce,"BooleanArray.prototype.reduce( reducerFn:Function[, initialValue:any] )"
@@ -2599,6 +2600,8 @@ BooleanArray.prototype.subarray,"BooleanArray.prototype.subarray( [begin:integer
25992600
BooleanArray.prototype.toReversed,"BooleanArray.prototype.toReversed()"
26002601
BooleanArray.prototype.toSorted,"BooleanArray.prototype.toSorted( [compareFunction:Function] )"
26012602
BooleanArray.prototype.toString,"BooleanArray.prototype.toString()"
2603+
BooleanArray.prototype.values,"BooleanArray.prototype.values()"
2604+
BooleanArray.prototype.with,"BooleanArray.prototype.with( index, value )"
26022605
broadcastArray,"broadcastArray( x:ndarray, shape:ArrayLikeObject )"
26032606
broadcastArrays,"broadcastArrays( ...arrays:ndarray|ArrayLikeObject<ndarray> )"
26042607
Buffer,"Buffer"

lib/node_modules/@stdlib/repl/typed-signature/data/data.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)