FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

doc: add `added:` information for util · nodejs/node@b92e3fc · GitHub

/ node Public

Commit b92e3fc

Browse files
lpinca
authored and
MylesBorins
committed
doc: add added: information for util
Ref: #8881 PR-URL: #8206 Reviewed-By: Roman Reiss <me@silverwind.io> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Stephen Belanger <admin@stephenbelanger.com> Reviewed-By: Bryan English <bryan@bryanenglish.com>
1 parent 578bf51 commit b92e3fc

1 file changed

Lines changed: 95 additions & 0 deletions

File tree

‎doc/api/util.md‎

Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,9 @@ are unnecessary for Node.js's internal functionality.
1919
Deprecated predecessor of `console.error`.
2020

2121
## util.debuglog(section)
22+
<!-- YAML
23+
added: v0.11.3
24+
-->
2225

2326
* `section` {String} The section of the program to be debugged
2427
* Returns: {Function} The logging function
@@ -52,6 +55,9 @@ You may separate multiple `NODE_DEBUG` environment variables with a
5255
comma. For example, `NODE_DEBUG=fs,net,tls`.
5356

5457
## util.deprecate(function, string)
58+
<!-- YAML
59+
added: v0.8.0
60+
-->
5561

5662
Marks that a method should not be used any more.
5763

@@ -82,12 +88,19 @@ when the deprecated API is used. Configurable at run-time through the
8288
`process.throwDeprecation` takes precedence over `process.traceDeprecation`.
8389

8490
## util.error([...])
91+
<!-- YAML
92+
added: v0.3.0
93+
deprecated: v0.11.3
94+
-->
8595

8696
> Stability: 0 - Deprecated: Use [`console.error()`][] instead.
8797
8898
Deprecated predecessor of `console.error`.
8999

90100
## util.format(format[, ...])
101+
<!-- YAML
102+
added: v0.5.3
103+
-->
91104

92105
Returns a formatted string using the first argument as a `printf`-like format.
93106

@@ -125,6 +138,9 @@ util.format(1, 2, 3); // '1 2 3'
125138
```
126139

127140
## util.inherits(constructor, superConstructor)
141+
<!-- YAML
142+
added: v0.3.0
143+
-->
128144

129145
Inherit the prototype methods from one [constructor][] into another. The
130146
prototype of `constructor` will be set to a new object created from
@@ -159,6 +175,9 @@ stream.write('It works!'); // Received data: "It works!"
159175
```
160176

161177
## util.inspect(object[, options])
178+
<!-- YAML
179+
added: v0.3.0
180+
-->
162181

163182
Return a string representation of `object`, which is useful for debugging.
164183

@@ -249,6 +268,10 @@ util.inspect(obj);
249268
```
250269

251270
## util.isArray(object)
271+
<!-- YAML
272+
added: v0.6.0
273+
deprecated: v4.0.0
274+
-->
252275

253276
> Stability: 0 - Deprecated
254277
@@ -268,6 +291,10 @@ util.isArray({})
268291
```
269292

270293
## util.isBoolean(object)
294+
<!-- YAML
295+
added: v0.11.5
296+
deprecated: v4.0.0
297+
-->
271298

272299
> Stability: 0 - Deprecated
273300
@@ -285,6 +312,10 @@ util.isBoolean(false)
285312
```
286313

287314
## util.isBuffer(object)
315+
<!-- YAML
316+
added: v0.11.5
317+
deprecated: v4.0.0
318+
-->
288319

289320
> Stability: 0 - Deprecated: Use [`Buffer.isBuffer()`][] instead.
290321
@@ -302,6 +333,10 @@ util.isBuffer(new Buffer('hello world'))
302333
```
303334

304335
## util.isDate(object)
336+
<!-- YAML
337+
added: v0.6.0
338+
deprecated: v4.0.0
339+
-->
305340

306341
> Stability: 0 - Deprecated
307342
@@ -319,6 +354,10 @@ util.isDate({})
319354
```
320355

321356
## util.isError(object)
357+
<!-- YAML
358+
added: v0.6.0
359+
deprecated: v4.0.0
360+
-->
322361

323362
> Stability: 0 - Deprecated
324363
@@ -337,6 +376,10 @@ util.isError({ name: 'Error', message: 'an error occurred' })
337376
```
338377

339378
## util.isFunction(object)
379+
<!-- YAML
380+
added: v0.11.5
381+
deprecated: v4.0.0
382+
-->
340383

341384
> Stability: 0 - Deprecated
342385
@@ -358,6 +401,10 @@ util.isFunction(Bar)
358401
```
359402

360403
## util.isNull(object)
404+
<!-- YAML
405+
added: v0.11.5
406+
deprecated: v4.0.0
407+
-->
361408

362409
> Stability: 0 - Deprecated
363410
@@ -376,6 +423,10 @@ util.isNull(null)
376423
```
377424

378425
## util.isNullOrUndefined(object)
426+
<!-- YAML
427+
added: v0.11.5
428+
deprecated: v4.0.0
429+
-->
379430

380431
> Stability: 0 - Deprecated
381432
@@ -394,6 +445,10 @@ util.isNullOrUndefined(null)
394445
```
395446

396447
## util.isNumber(object)
448+
<!-- YAML
449+
added: v0.11.5
450+
deprecated: v4.0.0
451+
-->
397452

398453
> Stability: 0 - Deprecated
399454
@@ -413,6 +468,10 @@ util.isNumber(NaN)
413468
```
414469

415470
## util.isObject(object)
471+
<!-- YAML
472+
added: v0.11.5
473+
deprecated: v4.0.0
474+
-->
416475

417476
> Stability: 0 - Deprecated
418477
@@ -433,6 +492,10 @@ util.isObject(function(){})
433492
```
434493

435494
## util.isPrimitive(object)
495+
<!-- YAML
496+
added: v0.11.5
497+
deprecated: v4.0.0
498+
-->
436499

437500
> Stability: 0 - Deprecated
438501
@@ -463,6 +526,10 @@ util.isPrimitive(new Date())
463526
```
464527

465528
## util.isRegExp(object)
529+
<!-- YAML
530+
added: v0.6.0
531+
deprecated: v4.0.0
532+
-->
466533

467534
> Stability: 0 - Deprecated
468535
@@ -480,6 +547,10 @@ util.isRegExp({})
480547
```
481548

482549
## util.isString(object)
550+
<!-- YAML
551+
added: v0.11.5
552+
deprecated: v4.0.0
553+
-->
483554

484555
> Stability: 0 - Deprecated
485556
@@ -499,6 +570,10 @@ util.isString(5)
499570
```
500571

501572
### util.isSymbol(object)
573+
<!-- YAML
574+
added: v0.11.5
575+
deprecated: v4.0.0
576+
-->
502577

503578
> Stability: 0 - Deprecated
504579
@@ -516,6 +591,10 @@ util.isSymbol(Symbol('foo'))
516591
```
517592

518593
## util.isUndefined(object)
594+
<!-- YAML
595+
added: v0.11.5
596+
deprecated: v4.0.0
597+
-->
519598

520599
> Stability: 0 - Deprecated
521600
@@ -534,24 +613,40 @@ util.isUndefined(null)
534613
```
535614

536615
## util.log(string)
616+
<!-- YAML
617+
added: v0.3.0
618+
deprecated: v6.0.0
619+
-->
537620

538621
Output with timestamp on `stdout`.
539622

540623
require('util').log('Timestamped message.');
541624

542625
## util.print([...])
626+
<!-- YAML
627+
added: v0.3.0
628+
deprecated: v0.11.3
629+
-->
543630

544631
> Stability: 0 - Deprecated: Use [`console.log()`][] instead.
545632
546633
Deprecated predecessor of `console.log`.
547634

548635
## util.pump(readableStream, writableStream[, callback])
636+
<!-- YAML
637+
added: v0.3.0
638+
deprecated: v0.9.1
639+
-->
549640

550641
> Stability: 0 - Deprecated: Use readableStream.pipe(writableStream)
551642
552643
Deprecated predecessor of `stream.pipe()`.
553644

554645
## util.puts([...])
646+
<!-- YAML
647+
added: v0.3.0
648+
deprecated: v0.11.3
649+
-->
555650

556651
> Stability: 0 - Deprecated: Use [`console.log()`][] instead.
557652

0 commit comments

Comments
 (0)
Back | FazBrowse Home | New Git URL