Skip to content

Commit 97f0e11

Browse files
committed
chore: use canonical format for JSDoc union types
--- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---
1 parent 7add020 commit 97f0e11

File tree

7 files changed

+10
-10
lines changed

7 files changed

+10
-10
lines changed

lib/node_modules/@stdlib/_tools/repl-txt/rules/resolvable-aliases/lib/main.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ function countLines( str ) {
4949
*
5050
* @private
5151
* @param {string} pkg - package path
52-
* @returns {string|null} package alias
52+
* @returns {(string|null)} package alias
5353
*/
5454
function pkg2alias( pkg ) {
5555
var i;

lib/node_modules/@stdlib/_tools/scaffold/test-validate-js/test/fixtures/validate.js_3.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ var format = require( '@stdlib/string/format' );
3939
* @param {(Buffer|string)} [options.html] - HTML content to serve
4040
* @param {(Buffer|string)} [options.javascript] - JavaScript script to serve
4141
* @param {boolean} [options.open] - indicates whether to launch a web browser
42-
* @returns {Error|null} error or null
42+
* @returns {(Error|null)} error or null
4343
*
4444
* @example
4545
* var options = {

lib/node_modules/@stdlib/fs/resolve-parent-paths/lib/sync.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ function all( paths, dir ) {
143143
* @private
144144
* @param {Array<string>} paths - paths to resolve
145145
* @param {string} dir - base directory
146-
* @returns {Array<string|null>} resolved paths
146+
* @returns {Array<(string|null)>} resolved paths
147147
*/
148148
function each( paths, dir ) {
149149
var count;
@@ -189,7 +189,7 @@ function each( paths, dir ) {
189189
* @throws {TypeError} first argument must be an array of strings
190190
* @throws {TypeError} options argument must be an object
191191
* @throws {TypeError} must provide valid options
192-
* @returns {Array<string|null>} resolved paths
192+
* @returns {Array<(string|null)>} resolved paths
193193
*
194194
* @example
195195
* var paths = resolveParentPaths( [ 'package.json', 'package-lock.json' ] );

lib/node_modules/@stdlib/utils/library-manifest/lib/validate.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ var hasOwnProp = Object.prototype.hasOwnProperty;
3939
* @param {Options} options - function options
4040
* @param {string} [options.basedir] - base search directory
4141
* @param {string} [options.paths] - path convention
42-
* @returns {Error|null} error or null
42+
* @returns {(Error|null)} error or null
4343
*
4444
* @example
4545
* var options = {

lib/node_modules/@stdlib/utils/parse-ndjson/lib/main.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ var reEOL = require( '@stdlib/regexp/eol' );
3737
* @param {Function} [reviver] - transformation function applied to each line
3838
* @throws {TypeError} first argument must be a string
3939
* @throws {TypeError} reviver must be a function
40-
* @returns {Array|Error} array of parsed values or an error
40+
* @returns {(Array|Error)} array of parsed values or an error
4141
*
4242
* @example
4343
* var out = parseNDJSON( '{"name":"John"}\n{"name":"Doe"}' );

lib/node_modules/@stdlib/utils/try-function/lib/main.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -65,17 +65,17 @@ function wrap( fcn, thisArg ) {
6565
*
6666
* @private
6767
* @param {...*} [args] - function arguments
68-
* @returns {*|Error} returned value or an error object
68+
* @returns {(*|Error)} returned value or an error object
6969
*/
7070
function wrapped() {
7171
var args;
7272
var len;
7373
var i;
7474

7575
len = arguments.length;
76-
args = new Array( len );
76+
args = [];
7777
for ( i = 0; i < len; i++ ) {
78-
args[ i ] = arguments[ i ];
78+
args.push( arguments[ i ] );
7979
}
8080
try {
8181
return fcn.apply( ctx, args );

lib/node_modules/@stdlib/utils/try-require/lib/main.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ var isError = require( '@stdlib/assert/is-error' );
2929
* Wraps `require` in a try/catch block.
3030
*
3131
* @param {string} id - module id
32-
* @returns {*|Error} `module.exports` of the resolved module or an error
32+
* @returns {(*|Error)} `module.exports` of the resolved module or an error
3333
*
3434
* @example
3535
* var out = tryRequire( 'beepboop' );

0 commit comments

Comments
 (0)