Skip to content

Commit 379f259

Browse files
stdlib-botkgryte
stdlib-bot
and
kgryte
authored
docs: update REPL namespace documentation
PR-URL: stdlib-js#2403 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 cd14ed3 commit 379f259

10 files changed

Lines changed: 19 additions & 9 deletions

File tree

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

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2575,8 +2575,10 @@ BooleanArray.prototype.findLast,"function predicate( v ) { return v === true; }\
25752575
BooleanArray.prototype.findLastIndex,"function predicate( v ) { return v === true; }\nvar arr = new BooleanArray( [ true, false, true ] )\nvar idx = arr.findLastIndex( predicate )\n"
25762576
BooleanArray.prototype.get,"var arr = new BooleanArray( 10 )\narr.set( true, 0 );\nvar v = arr.get( 0 )\n"
25772577
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"
2578+
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"
25782579
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"
25792580
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"
2581+
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"
25802582
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"
25812583
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"
25822584
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"
@@ -2752,7 +2754,7 @@ dayOfQuarter,"var day = dayOfQuarter()\nday = dayOfQuarter( new Date() )\nday =
27522754
dayOfYear,"var day = dayOfYear()\nday = dayOfYear( new Date() )\nday = dayOfYear( 12, 31, 2016 )\nday = dayOfYear( 'dec', 31, 2016 )\nday = dayOfYear( 'december', 31, 2016 )\n"
27532755
daysInMonth,"var num = daysInMonth()\nnum = daysInMonth( 2 )\nnum = daysInMonth( 2, 2016 )\nnum = daysInMonth( 2, 2017 )\nnum = daysInMonth( 'feb', 2016 )\nnum = daysInMonth( 'february', 2016 )\n"
27542756
daysInYear,"var num = daysInYear()\nnum = daysInYear( 2016 )\nnum = daysInYear( 2017 )\n"
2755-
ddot,"var xbuf = new Float64Array( [ 4.0, 2.0, -3.0, 5.0, -1.0 ] );\nvar x = array( xbuf );\nvar ybuf = new Float64Array( [ 2.0, 6.0, -1.0, -4.0, 8.0 ] );\nvar y = array( ybuf );\nddot( x, y )\n"
2757+
ddot,"var x = array( new Float64Array( [ 4.0, 2.0, -3.0, 5.0, -1.0 ] ) );\nvar y = array( new Float64Array( [ 2.0, 6.0, -1.0, -4.0, 8.0 ] ) );\nddot( x, y )\n"
27562758
debugSinkStream,"var s = debugSinkStream( { 'name': 'foo' } );\ns.write( 'a' );\ns.write( 'b' );\ns.write( 'c' );\ns.end();\n"
27572759
debugSinkStream.factory,"var opts = { 'objectMode': true, 'highWaterMark': 64 };\nvar createStream = debugSinkStream.factory( opts );\n"
27582760
debugSinkStream.objectMode,"var s = debugSinkStream.objectMode( { 'name': 'foo' } );\ns.write( { 'value': 'a' } );\ns.write( { 'value': 'b' } );\ns.write( { 'value': 'c' } );\ns.end();\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 & 3 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: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2575,8 +2575,10 @@ BooleanArray.prototype.findLast,"\nBooleanArray.prototype.findLast( predicate:Fu
25752575
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"
25762576
BooleanArray.prototype.get,"\nBooleanArray.prototype.get( i:integer )\n Returns an array element located at integer position (index) `i`.\n"
25772577
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"
2578+
BooleanArray.prototype.reverse,"\nBooleanArray.prototype.reverse()\n Reverses the array *in-place*.\n"
25782579
BooleanArray.prototype.set,"\nBooleanArray.prototype.set( v:bool|BooleanArray|ArrayLikeObject[, i:integer] )\n Sets one or more array elements.\n"
25792580
BooleanArray.prototype.sort,"\nBooleanArray.prototype.sort( [compareFunction:Function] )\n Sorts an array in-place.\n"
2581+
BooleanArray.prototype.toReversed,"\nBooleanArray.prototype.toReversed()\n Returns a new typed array containing the elements in reversed order.\n"
25802582
broadcastArray,"\nbroadcastArray( x:ndarray, shape:ArrayLikeObject )\n Broadcasts an ndarray to a specified shape.\n"
25812583
broadcastArrays,"\nbroadcastArrays( ...arrays:ndarray|ArrayLikeObject<ndarray> )\n Broadcasts ndarrays to a common shape.\n"
25822584
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: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2581,8 +2581,10 @@ BooleanArray.prototype.findLast,"BooleanArray.prototype.findLast( predicate[, th
25812581
BooleanArray.prototype.findLastIndex,"BooleanArray.prototype.findLastIndex( predicate[, thisArg] )"
25822582
BooleanArray.prototype.get,"BooleanArray.prototype.get( i )"
25832583
BooleanArray.prototype.map,"BooleanArray.prototype.map( clbk[, thisArg] )"
2584+
BooleanArray.prototype.reverse,"BooleanArray.prototype.reverse()"
25842585
BooleanArray.prototype.set,"BooleanArray.prototype.set( v[, i] )"
25852586
BooleanArray.prototype.sort,"BooleanArray.prototype.sort( [compareFunction] )"
2587+
BooleanArray.prototype.toReversed,"BooleanArray.prototype.toReversed()"
25862588
broadcastArray,"broadcastArray( x, shape )"
25872589
broadcastArrays,"broadcastArrays( ...arrays )"
25882590
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: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2581,8 +2581,10 @@ BooleanArray.prototype.findLast,"BooleanArray.prototype.findLast( predicate:Func
25812581
BooleanArray.prototype.findLastIndex,"BooleanArray.prototype.findLastIndex( predicate:Function[, thisArg:Any] )"
25822582
BooleanArray.prototype.get,"BooleanArray.prototype.get( i:integer )"
25832583
BooleanArray.prototype.map,"BooleanArray.prototype.map( clbk:Function[, thisArg:Any] )"
2584+
BooleanArray.prototype.reverse,"BooleanArray.prototype.reverse()"
25842585
BooleanArray.prototype.set,"BooleanArray.prototype.set( v:bool|BooleanArray|ArrayLikeObject[, i:integer] )"
25852586
BooleanArray.prototype.sort,"BooleanArray.prototype.sort( [compareFunction:Function] )"
2587+
BooleanArray.prototype.toReversed,"BooleanArray.prototype.toReversed()"
25862588
broadcastArray,"broadcastArray( x:ndarray, shape:ArrayLikeObject )"
25872589
broadcastArrays,"broadcastArrays( ...arrays:ndarray|ArrayLikeObject<ndarray> )"
25882590
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)