Skip to content

Commit bcc68de

Browse files
committed
doc: add added: information for util
PR-URL: #8206
1 parent f6a7434 commit bcc68de

File tree

1 file changed

+103
-1
lines changed

1 file changed

+103
-1
lines changed

doc/api/util.md

+103-1
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@ const util = require('util');
1111
```
1212

1313
## util.debuglog(section)
14+
<!-- YAML
15+
added: v0.11.3
16+
-->
1417

1518
* `section` {String} A string identifying the portion of the application for
1619
which the `debuglog` function is being created.
@@ -45,6 +48,9 @@ Multiple comma-separated `section` names may be specified in the `NODE_DEBUG`
4548
environment variable. For example: `NODE_DEBUG=fs,net,tls`.
4649

4750
## util.deprecate(function, string)
51+
<!-- YAML
52+
added: v0.8.0
53+
-->
4854

4955
The `util.deprecate()` method wraps the given `function` or class in such a way that
5056
it is marked as deprecated.
@@ -83,6 +89,9 @@ property take precedence over `--trace-deprecation` and
8389
`process.traceDeprecation`.
8490

8591
## util.format(format[, ...])
92+
<!-- YAML
93+
added: v0.5.3
94+
-->
8695

8796
* `format` {string} A `printf`-like format string.
8897

@@ -125,6 +134,9 @@ util.format(1, 2, 3); // '1 2 3'
125134
```
126135

127136
## util.inherits(constructor, superConstructor)
137+
<!-- YAML
138+
added: v0.3.0
139+
-->
128140

129141
_Note: usage of `util.inherits()` is discouraged. Please use the ES6 `class` and
130142
`extends` keywords to get language level inheritance support. Also note that
@@ -166,6 +178,9 @@ stream.write('It works!'); // Received data: "It works!"
166178
```
167179

168180
## util.inspect(object[, options])
181+
<!-- YAML
182+
added: v0.3.0
183+
-->
169184

170185
* `object` {any} Any JavaScript primitive or Object.
171186
* `options` {Object}
@@ -272,6 +287,9 @@ util.inspect(obj);
272287
```
273288

274289
### util.inspect.defaultOptions
290+
<!-- YAML
291+
added: v6.4.0
292+
-->
275293

276294
The `defaultOptions` value allows customization of the default options used by
277295
`util.inspect`. This is useful for functions like `console.log` or
@@ -294,6 +312,10 @@ The following APIs have been deprecated and should no longer be used. Existing
294312
applications and modules should be updated to find alternative approaches.
295313

296314
### util.debug(string)
315+
<!-- YAML
316+
added: v0.3.0
317+
deprecated: v0.11.3
318+
-->
297319

298320
> Stability: 0 - Deprecated: Use [`console.error()`][] instead.
299321
@@ -302,6 +324,10 @@ applications and modules should be updated to find alternative approaches.
302324
Deprecated predecessor of `console.error`.
303325

304326
### util.error([...])
327+
<!-- YAML
328+
added: v0.3.0
329+
deprecated: v0.11.3
330+
-->
305331

306332
> Stability: 0 - Deprecated: Use [`console.error()`][] instead.
307333
@@ -310,6 +336,10 @@ Deprecated predecessor of `console.error`.
310336
Deprecated predecessor of `console.error`.
311337

312338
### util.isArray(object)
339+
<!-- YAML
340+
added: v0.6.0
341+
deprecated: v4.0.0
342+
-->
313343

314344
> Stability: 0 - Deprecated
315345
@@ -331,6 +361,10 @@ util.isArray({});
331361
```
332362

333363
### util.isBoolean(object)
364+
<!-- YAML
365+
added: v0.11.5
366+
deprecated: v4.0.0
367+
-->
334368

335369
> Stability: 0 - Deprecated
336370
@@ -350,6 +384,10 @@ util.isBoolean(false);
350384
```
351385

352386
### util.isBuffer(object)
387+
<!-- YAML
388+
added: v0.11.5
389+
deprecated: v4.0.0
390+
-->
353391

354392
> Stability: 0 - Deprecated: Use [`Buffer.isBuffer()`][] instead.
355393
@@ -369,6 +407,10 @@ util.isBuffer(Buffer.from('hello world'));
369407
```
370408

371409
### util.isDate(object)
410+
<!-- YAML
411+
added: v0.6.0
412+
deprecated: v4.0.0
413+
-->
372414

373415
> Stability: 0 - Deprecated
374416
@@ -388,6 +430,10 @@ util.isDate({});
388430
```
389431

390432
### util.isError(object)
433+
<!-- YAML
434+
added: v0.6.0
435+
deprecated: v4.0.0
436+
-->
391437

392438
> Stability: 0 - Deprecated
393439
@@ -423,6 +469,10 @@ util.isError(obj);
423469
```
424470

425471
### util.isFunction(object)
472+
<!-- YAML
473+
added: v0.11.5
474+
deprecated: v4.0.0
475+
-->
426476

427477
> Stability: 0 - Deprecated
428478
@@ -446,6 +496,10 @@ util.isFunction(Bar);
446496
```
447497

448498
### util.isNull(object)
499+
<!-- YAML
500+
added: v0.11.5
501+
deprecated: v4.0.0
502+
-->
449503

450504
> Stability: 0 - Deprecated
451505
@@ -466,6 +520,10 @@ util.isNull(null);
466520
```
467521

468522
### util.isNullOrUndefined(object)
523+
<!-- YAML
524+
added: v0.11.5
525+
deprecated: v4.0.0
526+
-->
469527

470528
> Stability: 0 - Deprecated
471529
@@ -486,6 +544,10 @@ util.isNullOrUndefined(null);
486544
```
487545

488546
### util.isNumber(object)
547+
<!-- YAML
548+
added: v0.11.5
549+
deprecated: v4.0.0
550+
-->
489551

490552
> Stability: 0 - Deprecated
491553
@@ -507,6 +569,10 @@ util.isNumber(NaN);
507569
```
508570

509571
### util.isObject(object)
572+
<!-- YAML
573+
added: v0.11.5
574+
deprecated: v4.0.0
575+
-->
510576

511577
> Stability: 0 - Deprecated
512578
@@ -529,6 +595,10 @@ util.isObject(function(){});
529595
```
530596

531597
### util.isPrimitive(object)
598+
<!-- YAML
599+
added: v0.11.5
600+
deprecated: v4.0.0
601+
-->
532602

533603
> Stability: 0 - Deprecated
534604
@@ -561,6 +631,10 @@ util.isPrimitive(new Date());
561631
```
562632

563633
### util.isRegExp(object)
634+
<!-- YAML
635+
added: v0.6.0
636+
deprecated: v4.0.0
637+
-->
564638

565639
> Stability: 0 - Deprecated
566640
@@ -580,6 +654,10 @@ util.isRegExp({});
580654
```
581655

582656
### util.isString(object)
657+
<!-- YAML
658+
added: v0.11.5
659+
deprecated: v4.0.0
660+
-->
583661

584662
> Stability: 0 - Deprecated
585663
@@ -601,6 +679,10 @@ util.isString(5);
601679
```
602680

603681
### util.isSymbol(object)
682+
<!-- YAML
683+
added: v0.11.5
684+
deprecated: v4.0.0
685+
-->
604686

605687
> Stability: 0 - Deprecated
606688
@@ -620,6 +702,10 @@ util.isSymbol(Symbol('foo'));
620702
```
621703

622704
### util.isUndefined(object)
705+
<!-- YAML
706+
added: v0.11.5
707+
deprecated: v4.0.0
708+
-->
623709

624710
> Stability: 0 - Deprecated
625711
@@ -640,6 +726,10 @@ util.isUndefined(null);
640726
```
641727

642728
### util.log(string)
729+
<!-- YAML
730+
added: v0.3.0
731+
deprecated: v6.0.0
732+
-->
643733

644734
> Stability: 0 - Deprecated: Use a third party module instead.
645735
@@ -655,18 +745,30 @@ util.log('Timestamped message.');
655745
```
656746

657747
### util.print([...])
748+
<!-- YAML
749+
added: v0.3.0
750+
deprecated: v0.11.3
751+
-->
658752

659753
> Stability: 0 - Deprecated: Use [`console.log()`][] instead.
660754
661755
Deprecated predecessor of `console.log`.
662756

663757
### util.puts([...])
758+
<!-- YAML
759+
added: v0.3.0
760+
deprecated: v0.11.3
761+
-->
664762

665763
> Stability: 0 - Deprecated: Use [`console.log()`][] instead.
666764
667765
Deprecated predecessor of `console.log`.
668766

669-
### util._extend(obj)
767+
### util.\_extend(obj)
768+
<!-- YAML
769+
added: v0.7.5
770+
deprecated: v6.0.0
771+
-->
670772

671773
> Stability: 0 - Deprecated: Use [`Object.assign()`] instead.
672774

0 commit comments

Comments
 (0)