Skip to content

Commit d19f55f

Browse files
Planeshifterstdlib-bot
authored andcommitted
docs: update REPL namespace documentation
Signed-off-by: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com>
1 parent bccd3c3 commit d19f55f

10 files changed

Lines changed: 52 additions & 16 deletions

File tree

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

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5821,6 +5821,15 @@ Uint32Array.prototype.toLocaleString,"var arr = new Uint32Array( [ 1, 2, 3 ] );\
58215821
Uint32Array.prototype.toString,"var arr = new Uint32Array( [ 1, 2, 3 ] );\narr.toString()\n"
58225822
Uint32Array.prototype.values,"var arr = new Uint32Array( [ 1, 2 ] );\nit = arr.values();\nit.next().value\nit.next().value\nit.next().done\n"
58235823
Uint32Vector,"var arr = Uint32Vector()\nvar arr = Uint32Vector( 5 )\nvar len = numel( arr )\nvar v = [ 1, 2, 3 ];\nvar arr = Uint32Vector( v )\nvar len = numel( arr )\nvar buf = new ArrayBuffer( 32 );\nvar arr = Uint32Vector( buf, 0, 4 )\nvar len = numel( arr )\n"
5824+
Uint64,"var x = new Uint64( 5 )\nx.toString()\n"
5825+
Uint64.name,"var str = Uint64.name\n"
5826+
Uint64.from,"var v = Uint64.from( [ 1234, 5678 ] )\n"
5827+
Uint64.of,"var v = Uint64.of( 1234, 5678 )\n"
5828+
Uint64.BYTES_PER_ELEMENT,"var s = Uint64.BYTES_PER_ELEMENT\n"
5829+
Uint64.prototype.BYTES_PER_ELEMENT,"var x = new Uint64( 5 )\nvar s = x.BYTES_PER_ELEMENT\n"
5830+
Uint64.prototype.byteLength,"var x = new Uint64( 5 )\nvar s = x.byteLength\n"
5831+
Uint64.prototype.hi,"var x = Uint64.from( [ 1234, 5678 ] )\nvar w = x.hi\n"
5832+
Uint64.prototype.lo,"var x = Uint64.from( [ 1234, 5678 ] )\nvar w = x.lo\n"
58245833
umask,"var mask = umask()\nmask = umask( { 'symbolic': true } )\n"
58255834
uncapitalize,"var out = uncapitalize( 'Beep' )\nout = uncapitalize( 'bOOp' )\n"
58265835
uncapitalizeKeys,"var obj = { 'AA': 1, 'BB': 2 };\nvar out = uncapitalizeKeys( obj )\n"
@@ -5851,8 +5860,8 @@ US_STATES_NAMES,"var list = US_STATES_NAMES()\n"
58515860
US_STATES_NAMES_CAPITALS,"var out = US_STATES_NAMES_CAPITALS()\n"
58525861
utf16ToUTF8Array,"var str = '☃';\nvar out = utf16ToUTF8Array( str )\n"
58535862
vartest,"var x = [ 610, 610, 550, 590, 565, 570 ];\nvar y = [ 560, 550, 580, 550, 560, 590, 550, 590 ];\nvar out = vartest( x, y )\nvar table = out.print()\n"
5854-
vector,"var arr = vector()\narr = vector( 'float32' )\nvar arr = vector( 5 )\nvar len = numel( arr )\narr = vector( 5, 'float32' )\nlen = numel( arr )\nvar v = [ 0.5, 0.5, 0.5 ];\nvar arr = vector( v, 'float32' )\nvar len = numel( arr )\nvar buf = new ArrayBuffer( 32 );\nvar arr = vector( buf, 0, 4, 'float32' )\nvar len = numel( arr )\n"
5855-
vector.factory,"var f = vector.factory( 'float32' );\nvar arr = f()\n"
5863+
vector,"var arr = vector()\nvar dt = ndarrayDataType( arr )\narr = vector( 'float32' )\ndt = ndarrayDataType( arr )\nvar arr = vector( 5 )\nvar dt = ndarrayDataType( arr )\nvar len = numel( arr )\narr = vector( 5, 'float32' )\ndt = ndarrayDataType( arr )\nlen = numel( arr )\nvar v = [ 0.5, 0.5, 0.5 ];\nvar arr = vector( v, 'float32' )\nvar dt = ndarrayDataType( arr )\nvar len = numel( arr )\nvar buf = new ArrayBuffer( 32 );\nvar arr = vector( buf, 0, 4, 'float32' )\nvar dt = ndarrayDataType( arr )\nvar len = numel( arr )\n"
5864+
vector.factory,"var f = vector.factory( 'float32' );\nvar arr = f()\nvar dt = ndarrayDataType( arr )\n"
58565865
waterfall,"function foo( next ) { next( null, 'beep' ); };\nfunction bar( str, next ) { console.log( str ); next(); };\nfunction done( error ) { if ( error ) { throw error; } };\nvar fcns = [ foo, bar ];\nwaterfall( fcns, done );\n"
58575866
waterfall.factory,"function foo( next ) { next( null, 'beep' ); };\nfunction bar( str, next ) { console.log( str ); next(); };\nfunction done( error ) { if ( error ) { throw error; } };\nvar fcns = [ foo, bar ];\nvar waterfall = waterfall.factory( fcns, done );\nwaterfall();\nwaterfall();\nwaterfall();\n"
58585867
WebAssemblyMemory,"var mem = new WebAssemblyMemory( { 'initial': 0 } )\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: 2 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: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5823,6 +5823,15 @@ Uint32Array.prototype.toLocaleString,"\nUint32Array.prototype.toLocaleString( [l
58235823
Uint32Array.prototype.toString,"\nUint32Array.prototype.toString()\n Serializes an array as a string.\n"
58245824
Uint32Array.prototype.values,"\nUint32Array.prototype.values()\n Returns an iterator for iterating over array elements.\n"
58255825
Uint32Vector,"\nUint32Vector( [options:Object] )\n Returns a one-dimensional unsigned 32-bit integer ndarray.\n\nUint32Vector( length:integer[, options:Object] )\n Returns a one-dimensional unsigned 32-bit integer ndarray having a specified\n length.\n\nUint32Vector( obj:Object[, options:Object] )\n Creates a one-dimensional unsigned 32-bit integer ndarray from an array-like\n object or iterable.\n\nUint32Vector( buffer:ArrayBuffer[, byteOffset:integer[, length:integer]][, \n options:Object] )\n Returns a one-dimensional unsigned 32-bit integer ndarray view of an\n ArrayBuffer.\n"
5826+
Uint64,"\nUint64( value:number|bigint )\n Unsigned 64-bit integer constructor.\n"
5827+
Uint64.name,"\nUint64.name\n Constructor name.\n"
5828+
Uint64.from,"\nUint64.from( words:ArrayLikeObject )\n Creates a new unsigned 64-bit integer from an array-like object containing a\n high and low word.\n"
5829+
Uint64.of,"\nUint64.of( high:integer, low:integer )\n Creates a new unsigned 64-bit integer from a high and low word.\n"
5830+
Uint64.BYTES_PER_ELEMENT,"\nUint64.BYTES_PER_ELEMENT\n Size (in bytes) of the underlying value.\n"
5831+
Uint64.prototype.BYTES_PER_ELEMENT,"\nUint64.prototype.BYTES_PER_ELEMENT\n Size (in bytes) of the underlying value.\n"
5832+
Uint64.prototype.byteLength,"\nUint64.prototype.byteLength\n Size (in bytes) of the underlying value.\n"
5833+
Uint64.prototype.hi,"\nUint64.prototype.hi\n Returns the high 32-bit word of an unsigned 64-bit integer.\n"
5834+
Uint64.prototype.lo,"\nUint64.prototype.lo\n Returns the low 32-bit word of an unsigned 64-bit integer.\n"
58265835
umask,"\numask( [mask:integer|string,] [options:Object] )\n Returns the current process mask, if not provided a mask; otherwise, sets\n the process mask and returns the previous mask.\n"
58275836
uncapitalize,"\nuncapitalize( str:string )\n Lowercases the first character of a string.\n"
58285837
uncapitalizeKeys,"\nuncapitalizeKeys( obj:Object )\n Converts the first letter of each object key to lowercase.\n"
@@ -5853,8 +5862,8 @@ US_STATES_NAMES,"\nUS_STATES_NAMES()\n Returns a list of US state names in al
58535862
US_STATES_NAMES_CAPITALS,"\nUS_STATES_NAMES_CAPITALS()\n Returns an object mapping US state names to state capitals.\n"
58545863
utf16ToUTF8Array,"\nutf16ToUTF8Array( str:string )\n Converts a UTF-16 encoded string to an array of integers using UTF-8\n encoding.\n"
58555864
vartest,"\nvartest( x:Array<number>, y:Array<number>[, options:Object] )\n Computes a two-sample F-test for equal variances.\n"
5856-
vector,"\nvector( [dtype:string|DataType][, options:Object] )\n Returns a one-dimensional ndarray.\n\nvector( length:integer[, dtype:string|DataType][, options:Object] )\n Returns a one-dimensional ndarray having a specified length.\n\nvector( obj:Object[, dtype:string|DataType][, options:Object] )\n Creates a one-dimensional ndarray from an array-like object or iterable.\n\nvector( buffer:ArrayBuffer[, byteOffset:integer[, length:integer]][, \n dtype:string|DataType][, options:Object] )\n Returns a one-dimensional ndarray view of an ArrayBuffer.\n"
5857-
vector.factory,"\nvector.factory( dtype:string|DataType[, options:Object] )\n Returns a function for creating a one-dimensional ndarray.\n"
5865+
vector,"\nvector( [dtype:string][, options:Object] )\n Returns a one-dimensional ndarray.\n\nvector( length:integer[, dtype:string][, options:Object] )\n Returns a one-dimensional ndarray having a specified length.\n\nvector( obj:Object[, dtype:string][, options:Object] )\n Creates a one-dimensional ndarray from an array-like object or iterable.\n\nvector( buffer:ArrayBuffer[, byteOffset:integer[, length:integer]][, \n dtype:string][, options:Object] )\n Returns a one-dimensional ndarray view of an ArrayBuffer.\n"
5866+
vector.factory,"\nvector.factory( dtype:string[, options:Object] )\n Returns a function for creating a one-dimensional ndarray.\n"
58585867
waterfall,"\nwaterfall( fcns:Array<Function>, clbk:Function[, thisArg:any] )\n Executes functions in series, passing the results of one function as\n arguments to the next function.\n"
58595868
waterfall.factory,"\nwaterfall.factory( fcns:Array<Function>, clbk:Function[, thisArg:any] )\n Returns a reusable waterfall function.\n"
58605869
WebAssemblyMemory,"\nWebAssemblyMemory( descriptor:Object )\n WebAssembly memory constructor.\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: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5946,6 +5946,15 @@ Uint32Vector,"Uint32Vector( [options] )"
59465946
Uint32Vector,"Uint32Vector( length[, options] )"
59475947
Uint32Vector,"Uint32Vector( obj[, options] )"
59485948
Uint32Vector,"Uint32Vector( buffer[, byteOffset[, length]][, options] )"
5949+
Uint64,"Uint64( value )"
5950+
Uint64.name,"Uint64.name"
5951+
Uint64.from,"Uint64.from( words )"
5952+
Uint64.of,"Uint64.of( high, low )"
5953+
Uint64.BYTES_PER_ELEMENT,"Uint64.BYTES_PER_ELEMENT"
5954+
Uint64.prototype.BYTES_PER_ELEMENT,"Uint64.prototype.BYTES_PER_ELEMENT"
5955+
Uint64.prototype.byteLength,"Uint64.prototype.byteLength"
5956+
Uint64.prototype.hi,"Uint64.prototype.hi"
5957+
Uint64.prototype.lo,"Uint64.prototype.lo"
59495958
umask,"umask( [mask,] [options] )"
59505959
uncapitalize,"uncapitalize( str )"
59515960
uncapitalizeKeys,"uncapitalizeKeys( obj )"

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: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5946,6 +5946,15 @@ Uint32Vector,"Uint32Vector( [options:Object] )"
59465946
Uint32Vector,"Uint32Vector( length:integer[, options:Object] )"
59475947
Uint32Vector,"Uint32Vector( obj:Object[, options:Object] )"
59485948
Uint32Vector,"Uint32Vector( buffer:ArrayBuffer[, byteOffset:integer[, length:integer]][, options:Object] )"
5949+
Uint64,"Uint64( value:number|bigint )"
5950+
Uint64.name,"Uint64.name"
5951+
Uint64.from,"Uint64.from( words:ArrayLikeObject )"
5952+
Uint64.of,"Uint64.of( high:integer, low:integer )"
5953+
Uint64.BYTES_PER_ELEMENT,"Uint64.BYTES_PER_ELEMENT"
5954+
Uint64.prototype.BYTES_PER_ELEMENT,"Uint64.prototype.BYTES_PER_ELEMENT"
5955+
Uint64.prototype.byteLength,"Uint64.prototype.byteLength"
5956+
Uint64.prototype.hi,"Uint64.prototype.hi"
5957+
Uint64.prototype.lo,"Uint64.prototype.lo"
59495958
umask,"umask( [mask:integer|string,] [options:Object] )"
59505959
uncapitalize,"uncapitalize( str:string )"
59515960
uncapitalizeKeys,"uncapitalizeKeys( obj:Object )"
@@ -5976,11 +5985,11 @@ US_STATES_NAMES,"US_STATES_NAMES()"
59765985
US_STATES_NAMES_CAPITALS,"US_STATES_NAMES_CAPITALS()"
59775986
utf16ToUTF8Array,"utf16ToUTF8Array( str:string )"
59785987
vartest,"vartest( x:Array<number>, y:Array<number>[, options:Object] )"
5979-
vector,"vector( [dtype:string|DataType][, options:Object] )"
5980-
vector,"vector( length:integer[, dtype:string|DataType][, options:Object] )"
5981-
vector,"vector( obj:Object[, dtype:string|DataType][, options:Object] )"
5982-
vector,"vector( buffer:ArrayBuffer[, byteOffset:integer[, length:integer]][, dtype:string|DataType][, options:Object] )"
5983-
vector.factory,"vector.factory( dtype:string|DataType[, options:Object] )"
5988+
vector,"vector( [dtype:string][, options:Object] )"
5989+
vector,"vector( length:integer[, dtype:string][, options:Object] )"
5990+
vector,"vector( obj:Object[, dtype:string][, options:Object] )"
5991+
vector,"vector( buffer:ArrayBuffer[, byteOffset:integer[, length:integer]][, dtype:string][, options:Object] )"
5992+
vector.factory,"vector.factory( dtype:string[, options:Object] )"
59845993
waterfall,"waterfall( fcns:Array<Function>, clbk:Function[, thisArg:any] )"
59855994
waterfall.factory,"waterfall.factory( fcns:Array<Function>, clbk:Function[, thisArg:any] )"
59865995
WebAssemblyMemory,"WebAssemblyMemory( descriptor:Object )"

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)