Skip to content

Commit 085a82f

Browse files
Planeshifterstdlib-bot
authored andcommitted
docs: update REPL namespace documentation
Signed-off-by: stdlib-bot <[email protected]>
1 parent 03cae20 commit 085a82f

File tree

10 files changed

+10
-8
lines changed

10 files changed

+10
-8
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3152,7 +3152,7 @@ HOURS_IN_DAY,"var days = 3.14;\nvar hrs = days * HOURS_IN_DAY\n"
31523152
HOURS_IN_WEEK,"var wks = 3.14;\nvar hrs = wks * HOURS_IN_WEEK\n"
31533153
hoursInMonth,"var num = hoursInMonth()\nnum = hoursInMonth( 2 )\nnum = hoursInMonth( 2, 2016 )\nnum = hoursInMonth( 2, 2017 )\nnum = hoursInMonth( 'feb', 2016 )\nnum = hoursInMonth( 'february', 2016 )\n"
31543154
hoursInYear,"var num = hoursInYear()\nnum = hoursInYear( 2016 )\nnum = hoursInYear( 2017 )\n"
3155-
httpServer,"var createServer = httpServer()\nfunction onRequest( request, response ) {\nconsole.log( request.url );\nresponse.end( 'OK' );\n };\ncreateServer = httpServer( onRequest )\nvar opts = { 'port': 7331 };\ncreateServer = httpServer( opts )\n"
3155+
httpServer,"var httpServer = httpServer()\nfunction onRequest( request, response ) {\nconsole.log( request.url );\nresponse.end( 'OK' );\n };\nhttpServer = httpServer( onRequest )\nvar opts = { 'port': 7331 };\nhttpServer = httpServer( opts )\nfunction done( error, server ) {\nif ( error ) {\n throw error;\n}\nconsole.log( 'Success!' );\nserver.close();\n };\nvar httpServer = httpServer();\nhttpServer( done );\n"
31563156
identity,"var v = identity( 3.14 )\n"
31573157
ifelse,"var z = ifelse( true, 1.0, -1.0 )\nz = ifelse( false, 1.0, -1.0 )\n"
31583158
ifelseAsync,"function predicate( clbk ) {\n setTimeout( onTimeout, 0 );\n function onTimeout() {\n clbk( null, true );\n }\n };\nfunction done( error, result ) {\n if ( error ) {\n throw error;\n }\n console.log( result );\n };\nifelseAsync( predicate, 'beep', 'boop', done )\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: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3153,7 +3153,7 @@ HOURS_IN_DAY,"\nHOURS_IN_DAY\n Number of hours in a day.\n\n The value is
31533153
HOURS_IN_WEEK,"\nHOURS_IN_WEEK\n Number of hours in a week.\n\n The value is a generalization and does **not** take into account\n inaccuracies due to daylight savings conventions, crossing timezones, or\n other complications with time and dates.\n\n Examples\n --------\n > var wks = 3.14;\n > var hrs = wks * HOURS_IN_WEEK\n 527.52\n\n See Also\n --------\n HOURS_IN_DAY\n"
31543154
hoursInMonth,"\nhoursInMonth( [month[, year]] )\n Returns the number of hours in a month.\n\n By default, the function returns the number of hours in the current month of\n the current year (according to local time). To determine the number of hours\n for a particular month and year, provide `month` and `year` arguments.\n\n A `month` may be either a month's integer value, three letter abbreviation,\n or full name (case insensitive).\n\n The function's return value is a generalization and does **not** take into\n account inaccuracies due to daylight savings conventions, crossing\n timezones, or other complications with time and dates.\n\n Parameters\n ----------\n month: string|Date|integer (optional)\n Month.\n\n year: integer (optional)\n Year.\n\n Returns\n -------\n out: integer\n Hours in a month.\n\n Examples\n --------\n > var num = hoursInMonth()\n <number>\n > num = hoursInMonth( 2 )\n <number>\n > num = hoursInMonth( 2, 2016 )\n 696\n > num = hoursInMonth( 2, 2017 )\n 672\n\n // Other ways to supply month:\n > num = hoursInMonth( 'feb', 2016 )\n 696\n > num = hoursInMonth( 'february', 2016 )\n 696\n\n See Also\n --------\n hoursInYear\n"
31553155
hoursInYear,"\nhoursInYear( [value] )\n Returns the number of hours in a year according to the Gregorian calendar.\n\n By default, the function returns the number of hours in the current year\n (according to local time). To determine the number of hours for a particular\n year, provide either a year or a `Date` object.\n\n The function's return value is a generalization and does **not** take into\n account inaccuracies due to daylight savings conventions, crossing\n timezones, or other complications with time and dates.\n\n Parameters\n ----------\n value: integer|Date (optional)\n Year or `Date` object.\n\n Returns\n -------\n out: integer\n Number of hours in a year.\n\n Examples\n --------\n > var num = hoursInYear()\n <number>\n > num = hoursInYear( 2016 )\n 8784\n > num = hoursInYear( 2017 )\n 8760\n\n See Also\n --------\n hoursInMonth\n"
3156-
httpServer,"\nhttpServer( [options,] [requestListener] )\n Returns a function to create an HTTP server.\n\n Parameters\n ----------\n options: Object (optional)\n Options.\n\n options.port: integer (optional)\n Server port. Default: `0` (i.e., randomly assigned).\n\n options.maxport: integer (optional)\n Max server port when port hunting. Default: `maxport = port`.\n\n options.hostname: string (optional)\n Server hostname.\n\n options.address: string (optional)\n Server address. Default: `'127.0.0.1'`.\n\n requestListener: Function (optional)\n Request callback.\n\n Returns\n -------\n createServer: Function\n Function to create an HTTP server.\n\n Examples\n --------\n // Basic usage:\n > var createServer = httpServer()\n <Function>\n\n // Provide a request callback:\n > function onRequest( request, response ) {\n ... console.log( request.url );\n ... response.end( 'OK' );\n ... };\n > createServer = httpServer( onRequest )\n <Function>\n\n // Specify a specific port:\n > var opts = { 'port': 7331 };\n > createServer = httpServer( opts )\n <Function>\n\n\ncreateServer( done )\n Creates an HTTP server.\n\n Parameters\n ----------\n done: Function\n Callback to invoke after creating a server.\n\n Examples\n --------\n > function done( error, server ) {\n ... if ( error ) {\n ... throw error;\n ... }\n ... console.log( 'Success!' );\n ... server.close();\n ... };\n > var createServer = httpServer();\n > createServer( done );\n\n"
3156+
httpServer,"\nhttpServer( [options,] [requestListener] )\n Returns a function to create an HTTP server.\n\n In addition to options documented below, the function supports any options\n supported by `http.createServer`. Which server options are supported depends\n on the Node.js version. Older Node.js versions (e.g., <= v8.12.0) do not\n support an options object when calling `http.createServer`, and, for those\n versions, any options supported by `http.createServer` in later Node.js\n versions are ignored.\n\n Parameters\n ----------\n options: Object (optional)\n Options.\n\n options.port: integer (optional)\n Server port. Default: `0` (i.e., randomly assigned).\n\n options.maxport: integer (optional)\n Max server port when port hunting. Default: `maxport = port`.\n\n options.hostname: string (optional)\n Server hostname.\n\n options.address: string (optional)\n Server address. Default: `'127.0.0.1'`.\n\n requestListener: Function (optional)\n Request callback.\n\n Returns\n -------\n httpServer: Function\n Function to create an HTTP server.\n\n Examples\n --------\n // Basic usage:\n > var httpServer = httpServer()\n <Function>\n\n // Provide a request callback:\n > function onRequest( request, response ) {\n ... console.log( request.url );\n ... response.end( 'OK' );\n ... };\n > httpServer = httpServer( onRequest )\n <Function>\n\n // Specify a specific port:\n > var opts = { 'port': 7331 };\n > httpServer = httpServer( opts )\n <Function>\n\n\nhttpServer( done )\n Creates an HTTP server.\n\n Parameters\n ----------\n done: Function\n Callback to invoke after creating a server.\n\n Examples\n --------\n > function done( error, server ) {\n ... if ( error ) {\n ... throw error;\n ... }\n ... console.log( 'Success!' );\n ... server.close();\n ... };\n > var httpServer = httpServer();\n > httpServer( done );\n\n"
31573157
identity,"\nidentity( x )\n Identity function.\n\n Parameters\n ----------\n x: any\n Input value.\n\n Returns\n -------\n out: any\n Input value.\n\n Examples\n --------\n > var v = identity( 3.14 )\n 3.14\n\n See Also\n --------\n constantFunction\n"
31583158
ifelse,"\nifelse( bool, x, y )\n If a condition is truthy, returns `x`; otherwise, returns `y`.\n\n Parameters\n ----------\n bool: boolean\n Condition.\n\n x: any\n Value to return if a condition is truthy.\n\n y: any\n Value to return if a condition is falsy.\n\n Returns\n -------\n z: any\n Either `x` or `y`.\n\n Examples\n --------\n > var z = ifelse( true, 1.0, -1.0 )\n 1.0\n > z = ifelse( false, 1.0, -1.0 )\n -1.0\n\n See Also\n --------\n ifelseAsync, ifthen\n"
31593159
ifelseAsync,"\nifelseAsync( predicate, x, y, done )\n If a predicate function returns a truthy value, returns `x`; otherwise,\n returns `y`.\n\n A predicate function is provided a single argument:\n\n - clbk: callback to invoke upon predicate completion.\n\n The callback function accepts two arguments:\n\n - error: error object.\n - bool: condition used to determine whether to invoke `x` or `y`.\n\n The `done` callback is invoked upon function completion and is provided at\n most two arguments:\n\n - error: error object.\n - result: either `x` or `y`.\n\n Execution is *not* guaranteed to be asynchronous. To guarantee asynchrony,\n wrap the `done` callback in a function which either executes at the end of\n the current stack (e.g., `nextTick`) or during a subsequent turn of the\n event loop (e.g., `setImmediate`, `setTimeout`).\n\n Parameters\n ----------\n predicate: Function\n Predicate function.\n\n x: any\n Value to return if a condition is truthy.\n\n y: any\n Value to return if a condition is falsy.\n\n done: Function\n Callback to invoke upon completion.\n\n Examples\n --------\n > function predicate( clbk ) {\n ... setTimeout( onTimeout, 0 );\n ... function onTimeout() {\n ... clbk( null, true );\n ... }\n ... };\n > function done( error, result ) {\n ... if ( error ) {\n ... throw error;\n ... }\n ... console.log( result );\n ... };\n > ifelseAsync( predicate, 'beep', 'boop', done )\n 'beep'\n\n See Also\n --------\n ifthenAsync, ifelse\n"

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: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3153,7 +3153,7 @@ HOURS_IN_DAY,"\nHOURS_IN_DAY\n Number of hours in a day.\n"
31533153
HOURS_IN_WEEK,"\nHOURS_IN_WEEK\n Number of hours in a week.\n"
31543154
hoursInMonth,"\nhoursInMonth( [month:string|Date|integer[, year:integer]] )\n Returns the number of hours in a month.\n"
31553155
hoursInYear,"\nhoursInYear( [value:integer|Date] )\n Returns the number of hours in a year according to the Gregorian calendar.\n"
3156-
httpServer,"\nhttpServer( [options:Object,] [requestListener:Function] )\n Returns a function to create an HTTP server.\n"
3156+
httpServer,"\nhttpServer( [options:Object,] [requestListener:Function] )\n Returns a function to create an HTTP server.\n\nhttpServer( done:Function )\n Creates an HTTP server.\n"
31573157
identity,"\nidentity( x:any )\n Identity function.\n"
31583158
ifelse,"\nifelse( bool:boolean, x:any, y:any )\n If a condition is truthy, returns `x`; otherwise, returns `y`.\n"
31593159
ifelseAsync,"\nifelseAsync( predicate:Function, x:any, y:any, done:Function )\n If a predicate function returns a truthy value, returns `x`; otherwise,\n returns `y`.\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: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3193,6 +3193,7 @@ HOURS_IN_WEEK,"HOURS_IN_WEEK"
31933193
hoursInMonth,"hoursInMonth( [month[, year]] )"
31943194
hoursInYear,"hoursInYear( [value] )"
31953195
httpServer,"httpServer( [options,] [requestListener] )"
3196+
httpServer,"httpServer( done )"
31963197
identity,"identity( x )"
31973198
ifelse,"ifelse( bool, x, y )"
31983199
ifelseAsync,"ifelseAsync( predicate, x, y, done )"

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: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3193,6 +3193,7 @@ HOURS_IN_WEEK,"HOURS_IN_WEEK"
31933193
hoursInMonth,"hoursInMonth( [month:string|Date|integer[, year:integer]] )"
31943194
hoursInYear,"hoursInYear( [value:integer|Date] )"
31953195
httpServer,"httpServer( [options:Object,] [requestListener:Function] )"
3196+
httpServer,"httpServer( done:Function )"
31963197
identity,"identity( x:any )"
31973198
ifelse,"ifelse( bool:boolean, x:any, y:any )"
31983199
ifelseAsync,"ifelseAsync( predicate:Function, x:any, y:any, done: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)