File tree 8 files changed +16
-22
lines changed
lib/node_modules/@stdlib/error/tools
8 files changed +16
-22
lines changed Original file line number Diff line number Diff line change @@ -46,7 +46,7 @@ Returns an error message corresponding to a provided two-character error identif
46
46
47
47
``` javascript
48
48
var v = id2msg ( ' 8t' );
49
- // returns 'invalid option. `%s` option must be an array. Option: `%s`.'
49
+ // e.g., returns 'invalid option. `%s` option must be an array. Option: `%s`.'
50
50
```
51
51
52
52
If provided an unrecognized error identifier, the function returns ` null ` .
@@ -82,7 +82,6 @@ var v = id2msg( 'beep_boop' );
82
82
var id2msg = require ( ' @stdlib/error/tools/id2msg' );
83
83
84
84
var list;
85
- var len;
86
85
var v;
87
86
var i;
88
87
@@ -93,9 +92,8 @@ list = [
93
92
' 0a' ,
94
93
' 9W'
95
94
];
96
- len = list .length ;
97
95
98
- for ( i = 0 ; i < len ; i++ ) {
96
+ for ( i = 0 ; i < list . length ; i++ ) {
99
97
v = list[ i ];
100
98
console .log ( ' id: "%s". msg: "%s".' , v, id2msg ( v ) );
101
99
}
@@ -148,7 +146,7 @@ Options:
148
146
149
147
``` bash
150
148
$ stdlib-id2msg ' 8t'
151
- invalid option. ` %s ` option must be an array. Option: ` %s ` .
149
+ < string >
152
150
```
153
151
154
152
</section >
Original file line number Diff line number Diff line change 16
16
Examples
17
17
--------
18
18
> var v = {{alias}}( '8t' )
19
- 'invalid option. `%s` option must be an array. Option: `%s`.'
19
+ <string>
20
20
21
21
See Also
22
22
--------
Original file line number Diff line number Diff line change 26
26
*
27
27
* @example
28
28
* var v = id2msg( '8t' );
29
- * // returns 'invalid option. `%s` option must be an array. Option: `%s`.'
29
+ * // returns <string>
30
30
*/
31
31
declare function id2msg ( id : string ) : string | null ;
32
32
Original file line number Diff line number Diff line change 21
21
var id2msg = require ( './../lib' ) ;
22
22
23
23
var list ;
24
- var len ;
25
24
var v ;
26
25
var i ;
27
26
@@ -32,9 +31,8 @@ list = [
32
31
'0a' ,
33
32
'9W'
34
33
] ;
35
- len = list . length ;
36
34
37
- for ( i = 0 ; i < len ; i ++ ) {
35
+ for ( i = 0 ; i < list . length ; i ++ ) {
38
36
v = list [ i ] ;
39
37
console . log ( 'id: "%s". msg: "%s".' , v , id2msg ( v ) ) ;
40
38
}
Original file line number Diff line number Diff line change 27
27
* var id2msg = require( '@stdlib/error/tools/id2msg' );
28
28
*
29
29
* var v = id2msg( '8t' );
30
- * // returns 'invalid option. `%s` option must be an array. Option: `%s`.'
30
+ * // e.g., returns 'invalid option. `%s` option must be an array. Option: `%s`.'
31
31
*/
32
32
33
33
// MODULES //
Original file line number Diff line number Diff line change @@ -41,8 +41,12 @@ var db;
41
41
* @returns {(string|null) } error message
42
42
*
43
43
* @example
44
- * var v = id2msg( '8t' );
45
- * // returns 'invalid option. `%s` option must be an array. Option: `%s`.'
44
+ * var v = id2msg( '9b' );
45
+ * // returns <string>
46
+ *
47
+ * @example
48
+ * var v = id2msg( 'boop' );
49
+ * // returns null
46
50
*/
47
51
function id2msg ( id ) {
48
52
if ( ! isString ( id ) ) {
Original file line number Diff line number Diff line change @@ -46,7 +46,7 @@ Returns a two-character error identifier corresponding to a provided error messa
46
46
47
47
``` javascript
48
48
var v = msg2id ( ' invalid value. `%s` must be a number. Value: `%s`.' );
49
- // returns '6d'
49
+ // e.g., returns '6d'
50
50
```
51
51
52
52
If provided an unrecognized error message, the function returns ` null ` .
@@ -74,25 +74,21 @@ var v = msg2id( 'beep boop baz' );
74
74
75
75
## Examples
76
76
77
- <!-- TODO: better example -->
78
-
79
77
<!-- eslint no-undef: "error" -->
80
78
81
79
``` javascript
82
80
var msg2id = require ( ' @stdlib/error/tools/msg2id' );
83
81
84
82
var list;
85
- var len;
86
83
var v;
87
84
var i;
88
85
89
86
list = [
90
87
' invalid argument. First argument must be a number and not `NaN`. Value: `%s`.' ,
91
88
' invalid argument. First argument must be a positive integer. Value: `%s`.'
92
89
];
93
- len = list .length ;
94
90
95
- for ( i = 0 ; i < len ; i++ ) {
91
+ for ( i = 0 ; i < list . length ; i++ ) {
96
92
v = list[ i ];
97
93
console .log ( ' msg: "%s". id: "%s".' , v, msg2id ( v ) );
98
94
}
Original file line number Diff line number Diff line change 21
21
var msg2id = require ( './../lib' ) ;
22
22
23
23
var list ;
24
- var len ;
25
24
var v ;
26
25
var i ;
27
26
28
27
list = [
29
28
'invalid argument. First argument must be a number and not `NaN`. Value: `%s`.' ,
30
29
'invalid argument. First argument must be a positive integer. Value: `%s`.'
31
30
] ;
32
- len = list . length ;
33
31
34
- for ( i = 0 ; i < len ; i ++ ) {
32
+ for ( i = 0 ; i < list . length ; i ++ ) {
35
33
v = list [ i ] ;
36
34
console . log ( 'msg: "%s". id: "%s".' , v , msg2id ( v ) ) ;
37
35
}
You can’t perform that action at this time.
0 commit comments