Skip to content

Commit 337a10f

Browse files
Update namespace TypeScript declarations (stdlib-js#786)
Co-authored-by: kgryte <kgryte@users.noreply.github.com>
1 parent 500b7a6 commit 337a10f

File tree

1 file changed

+23
-0
lines changed
  • lib/node_modules/@stdlib/console/docs/types

1 file changed

+23
-0
lines changed

lib/node_modules/@stdlib/console/docs/types/index.d.ts

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@
2222
/* tslint:disable:max-file-line-count */
2323

2424
import log = require( '@stdlib/console/log' );
25+
import logEach = require( '@stdlib/console/log-each' );
2526

2627
/**
2728
* Interface describing the `console` namespace.
@@ -40,6 +41,28 @@ interface Namespace {
4041
* ns.log( 'Hello, %s!', 'World' );
4142
*/
4243
log: typeof log;
44+
45+
/**
46+
* Inserts array element values into a format string and prints the result.
47+
*
48+
* ## Notes
49+
*
50+
* - If an interpolated argument is not a collection, the argument is broadcasted for each iteration.
51+
*
52+
* @param str - format string
53+
* @param args - collections or values
54+
* @throws {RangeError} provided collections must have the same length
55+
*
56+
* @example
57+
* var ns.logEach = require( `@stdlib/console/log-each` );
58+
*
59+
* var x = [ 1, 2, 3 ];
60+
* var y = [ 4, 5, 6 ];
61+
*
62+
* ns.logEach( '%d < %d ', x, y );
63+
* // e.g., => '1 < 4\n2 < 5\n3 < 6\n'
64+
*/
65+
logEach: typeof logEach;
4366
}
4467

4568
/**

0 commit comments

Comments
 (0)