Skip to content

Commit 1c27809

Browse files
stdlib-botkgryte
andauthored
docs: update REPL namespace documentation
PR-URL: #2426 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 bd678e5 commit 1c27809

File tree

10 files changed

+25
-11
lines changed

10 files changed

+25
-11
lines changed

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

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ alias2standalone,"var v = alias2standalone( 'base.sin' )\n"
1616
aliases,"var o = aliases()\no = aliases( '@stdlib/math/base/special' )\n"
1717
allocUnsafe,"var buf = allocUnsafe( 100 )\n"
1818
amskfilter,"var x = [ 1, 2, 3, 4 ];\nvar y = amskfilter( x, [ 0, 1, 0, 1 ] )\n"
19+
amskput,"var x = [ 1, 2, 3, 4 ];\nvar out = amskput( x, [ 1, 0, 1, 0 ], [ 20, 40 ] )\nvar bool = ( out === x )\n"
1920
amskreject,"var x = [ 1, 2, 3, 4 ];\nvar y = amskreject( x, [ 0, 1, 0, 1 ] )\n"
2021
anans,"var arr = anans( 2 )\narr = anans( 2, 'float32' )\n"
2122
anansLike,"var x = new Float64Array( 2 );\nvar y = anansLike( x )\ny = anansLike( x, 'float32' )\n"
@@ -2570,6 +2571,7 @@ BooleanArray.prototype.byteLength,"var arr = new BooleanArray( 10 )\nvar nbytes
25702571
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"
25712572
BooleanArray.prototype.BYTES_PER_ELEMENT,"var arr = new BooleanArray( 10 )\narr.BYTES_PER_ELEMENT\n"
25722573
BooleanArray.prototype.length,"var arr = new BooleanArray( 10 )\nvar len = arr.length\n"
2574+
BooleanArray.prototype.every,"function predicate( v ) { return v === true; };\nvar arr = new BooleanArray( [ true, true, true ] )\nvar bool = arr.every( predicate )\n"
25732575
BooleanArray.prototype.find,"function predicate( v ) { return v === true; }\nvar arr = new BooleanArray( [ true, false, true ] )\nvar v = arr.find( predicate )\n"
25742576
BooleanArray.prototype.findIndex,"function predicate( v ) { return v === true; }\nvar arr = new BooleanArray( [ true, false, true ] )\nvar idx = arr.findIndex( predicate )\n"
25752577
BooleanArray.prototype.findLast,"function predicate( v ) { return v === true; }\nvar arr = new BooleanArray( [ true, false, true ] )\nvar v = arr.findLast( predicate )\n"
@@ -2578,6 +2580,7 @@ BooleanArray.prototype.get,"var arr = new BooleanArray( 10 )\narr.set( true, 0 )
25782580
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"
25792581
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"
25802582
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"
2583+
BooleanArray.prototype.some,"function predicate( v ) { return v === true; };\nvar arr = new BooleanArray( [ false, true, false ] )\nvar bool = arr.some( predicate )\n"
25812584
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"
25822585
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"
25832586
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"
@@ -2756,7 +2759,7 @@ dayOfQuarter,"var day = dayOfQuarter()\nday = dayOfQuarter( new Date() )\nday =
27562759
dayOfYear,"var day = dayOfYear()\nday = dayOfYear( new Date() )\nday = dayOfYear( 12, 31, 2016 )\nday = dayOfYear( 'dec', 31, 2016 )\nday = dayOfYear( 'december', 31, 2016 )\n"
27572760
daysInMonth,"var num = daysInMonth()\nnum = daysInMonth( 2 )\nnum = daysInMonth( 2, 2016 )\nnum = daysInMonth( 2, 2017 )\nnum = daysInMonth( 'feb', 2016 )\nnum = daysInMonth( 'february', 2016 )\n"
27582761
daysInYear,"var num = daysInYear()\nnum = daysInYear( 2016 )\nnum = daysInYear( 2017 )\n"
2759-
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"
2762+
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"
27602763
debugSinkStream,"var s = debugSinkStream( { 'name': 'foo' } );\ns.write( 'a' );\ns.write( 'b' );\ns.write( 'c' );\ns.end();\n"
27612764
debugSinkStream.factory,"var opts = { 'objectMode': true, 'highWaterMark': 64 };\nvar createStream = debugSinkStream.factory( opts );\n"
27622765
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: 7 additions & 5 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
@@ -16,6 +16,7 @@ alias2standalone,"\nalias2standalone( alias:string )\n Returns the standalone
1616
aliases,"\naliases( [namespace:string] )\n Returns a list of standard library aliases.\n"
1717
allocUnsafe,"\nallocUnsafe( size:integer )\n Allocates a buffer having a specified number of bytes.\n"
1818
amskfilter,"\namskfilter( x:Array|TypedArray|Object, mask:Array|TypedArray|Object )\n Returns a new array by applying a mask to a provided input array.\n"
19+
amskput,"\namskput( x:ArrayLikeObject, mask:ArrayLikeObject, values:ArrayLikeObject[, \n options:Object] )\n Replaces elements of an array with provided values according to a provided\n mask array.\n"
1920
amskreject,"\namskreject( x:Array|TypedArray|Object, mask:Array|TypedArray|Object )\n Returns a new array by applying a mask to a provided input array.\n"
2021
anans,"\nanans( length:integer[, dtype:string] )\n Returns an array filled with NaNs and having a specified length.\n"
2122
anansLike,"\nanansLike( x:TypedArray|Array[, dtype:string] )\n Returns an array filled with NaNs and having the same length and data type\n as a provided input array.\n"
@@ -2570,6 +2571,7 @@ BooleanArray.prototype.byteLength,"\nBooleanArray.prototype.byteLength\n Size
25702571
BooleanArray.prototype.byteOffset,"\nBooleanArray.prototype.byteOffset\n Offset (in bytes) of the array from the start of its underlying\n ArrayBuffer.\n"
25712572
BooleanArray.prototype.BYTES_PER_ELEMENT,"\nBooleanArray.prototype.BYTES_PER_ELEMENT\n Size (in bytes) of each array element.\n"
25722573
BooleanArray.prototype.length,"\nBooleanArray.prototype.length\n The number of array elements.\n"
2574+
BooleanArray.prototype.every,"\nBooleanArray.prototype.every( predicate:Function[, thisArg:Any] )\n Returns a boolean indicating whether all elements in the array pass a test.\n"
25732575
BooleanArray.prototype.find,"\nBooleanArray.prototype.find( predicate:Function[, thisArg:Any] )\n Returns the first element in an array for which a predicate function returns\n a truthy value.\n"
25742576
BooleanArray.prototype.findIndex,"\nBooleanArray.prototype.findIndex( predicate:Function[, thisArg:Any] )\n Returns the index of the first element in an array for which a predicate\n function returns a truthy value.\n"
25752577
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"
@@ -2578,6 +2580,7 @@ BooleanArray.prototype.get,"\nBooleanArray.prototype.get( i:integer )\n Retur
25782580
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"
25792581
BooleanArray.prototype.reverse,"\nBooleanArray.prototype.reverse()\n Reverses the array *in-place*.\n"
25802582
BooleanArray.prototype.set,"\nBooleanArray.prototype.set( v:bool|BooleanArray|ArrayLikeObject[, i:integer] )\n Sets one or more array elements.\n"
2583+
BooleanArray.prototype.some,"\nBooleanArray.prototype.some( predicate[, thisArg] )\n Returns a boolean indicating whether at least one element passes a test.\n"
25812584
BooleanArray.prototype.sort,"\nBooleanArray.prototype.sort( [compareFunction:Function] )\n Sorts an array in-place.\n"
25822585
BooleanArray.prototype.toReversed,"\nBooleanArray.prototype.toReversed()\n Returns a new typed array containing the elements in reversed order.\n"
25832586
BooleanArray.prototype.toSorted,"\nBooleanArray.prototype.toSorted( [compareFunction:Function] )\n Returns a new typed array containing the elements in sorted order.\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
@@ -16,6 +16,7 @@ alias2standalone,"alias2standalone( alias )"
1616
aliases,"aliases( [namespace] )"
1717
allocUnsafe,"allocUnsafe( size )"
1818
amskfilter,"amskfilter( x, mask )"
19+
amskput,"amskput( x, mask, values[, options] )"
1920
amskreject,"amskreject( x, mask )"
2021
anans,"anans( length[, dtype] )"
2122
anansLike,"anansLike( x[, dtype] )"
@@ -2576,6 +2577,7 @@ BooleanArray.prototype.byteLength,"BooleanArray.prototype.byteLength"
25762577
BooleanArray.prototype.byteOffset,"BooleanArray.prototype.byteOffset"
25772578
BooleanArray.prototype.BYTES_PER_ELEMENT,"BooleanArray.prototype.BYTES_PER_ELEMENT"
25782579
BooleanArray.prototype.length,"BooleanArray.prototype.length"
2580+
BooleanArray.prototype.every,"BooleanArray.prototype.every( predicate[, thisArg] )"
25792581
BooleanArray.prototype.find,"BooleanArray.prototype.find( predicate[, thisArg] )"
25802582
BooleanArray.prototype.findIndex,"BooleanArray.prototype.findIndex( predicate[, thisArg] )"
25812583
BooleanArray.prototype.findLast,"BooleanArray.prototype.findLast( predicate[, thisArg] )"
@@ -2584,6 +2586,7 @@ BooleanArray.prototype.get,"BooleanArray.prototype.get( i )"
25842586
BooleanArray.prototype.map,"BooleanArray.prototype.map( clbk[, thisArg] )"
25852587
BooleanArray.prototype.reverse,"BooleanArray.prototype.reverse()"
25862588
BooleanArray.prototype.set,"BooleanArray.prototype.set( v[, i] )"
2589+
BooleanArray.prototype.some,"BooleanArray.prototype.some( predicate[, thisArg] )"
25872590
BooleanArray.prototype.sort,"BooleanArray.prototype.sort( [compareFunction] )"
25882591
BooleanArray.prototype.toReversed,"BooleanArray.prototype.toReversed()"
25892592
BooleanArray.prototype.toSorted,"BooleanArray.prototype.toSorted( [compareFunction] )"

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
@@ -16,6 +16,7 @@ alias2standalone,"alias2standalone( alias:string )"
1616
aliases,"aliases( [namespace:string] )"
1717
allocUnsafe,"allocUnsafe( size:integer )"
1818
amskfilter,"amskfilter( x:Array|TypedArray|Object, mask:Array|TypedArray|Object )"
19+
amskput,"amskput( x:ArrayLikeObject, mask:ArrayLikeObject, values:ArrayLikeObject[, options:Object] )"
1920
amskreject,"amskreject( x:Array|TypedArray|Object, mask:Array|TypedArray|Object )"
2021
anans,"anans( length:integer[, dtype:string] )"
2122
anansLike,"anansLike( x:TypedArray|Array[, dtype:string] )"
@@ -2576,6 +2577,7 @@ BooleanArray.prototype.byteLength,"BooleanArray.prototype.byteLength"
25762577
BooleanArray.prototype.byteOffset,"BooleanArray.prototype.byteOffset"
25772578
BooleanArray.prototype.BYTES_PER_ELEMENT,"BooleanArray.prototype.BYTES_PER_ELEMENT"
25782579
BooleanArray.prototype.length,"BooleanArray.prototype.length"
2580+
BooleanArray.prototype.every,"BooleanArray.prototype.every( predicate:Function[, thisArg:Any] )"
25792581
BooleanArray.prototype.find,"BooleanArray.prototype.find( predicate:Function[, thisArg:Any] )"
25802582
BooleanArray.prototype.findIndex,"BooleanArray.prototype.findIndex( predicate:Function[, thisArg:Any] )"
25812583
BooleanArray.prototype.findLast,"BooleanArray.prototype.findLast( predicate:Function[, thisArg:Any] )"
@@ -2584,6 +2586,7 @@ BooleanArray.prototype.get,"BooleanArray.prototype.get( i:integer )"
25842586
BooleanArray.prototype.map,"BooleanArray.prototype.map( clbk:Function[, thisArg:Any] )"
25852587
BooleanArray.prototype.reverse,"BooleanArray.prototype.reverse()"
25862588
BooleanArray.prototype.set,"BooleanArray.prototype.set( v:bool|BooleanArray|ArrayLikeObject[, i:integer] )"
2589+
BooleanArray.prototype.some,"BooleanArray.prototype.some( predicate[, thisArg] )"
25872590
BooleanArray.prototype.sort,"BooleanArray.prototype.sort( [compareFunction:Function] )"
25882591
BooleanArray.prototype.toReversed,"BooleanArray.prototype.toReversed()"
25892592
BooleanArray.prototype.toSorted,"BooleanArray.prototype.toSorted( [compareFunction:Function] )"

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)