Skip to content

Commit 3c195d0

Browse files
committed
doc refactor: util
1 parent c417de4 commit 3c195d0

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

doc/api/util.markdown

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
## util
1+
# util
22

33
These functions are in the module `'util'`. Use `require('util')` to access
44
them.
55

66

7-
### util.format()
7+
## util.format()
88

99
Returns a formatted string using the first argument as a `printf`-like format.
1010

@@ -35,22 +35,22 @@ Each argument is converted to a string with `util.inspect()`.
3535
util.format(1, 2, 3); // '1 2 3'
3636

3737

38-
### util.debug(string)
38+
## util.debug(string)
3939

4040
A synchronous output function. Will block the process and
4141
output `string` immediately to `stderr`.
4242

4343
require('util').debug('message on stderr');
4444

4545

46-
### util.log(string)
46+
## util.log(string)
4747

4848
Output with timestamp on `stdout`.
4949

5050
require('util').log('Timestamped message.');
5151

5252

53-
### util.inspect(object, [showHidden], [depth], [colors])
53+
## util.inspect(object, [showHidden], [depth], [colors])
5454

5555
Return a string representation of `object`, which is useful for debugging.
5656

@@ -73,7 +73,7 @@ Example of inspecting all properties of the `util` object:
7373
console.log(util.inspect(util, true, null));
7474

7575

76-
### util.isArray(object)
76+
## util.isArray(object)
7777

7878
Returns `true` if the given "object" is an `Array`. `false` otherwise.
7979

@@ -87,7 +87,7 @@ Returns `true` if the given "object" is an `Array`. `false` otherwise.
8787
// false
8888

8989

90-
### util.isRegExp(object)
90+
## util.isRegExp(object)
9191

9292
Returns `true` if the given "object" is a `RegExp`. `false` otherwise.
9393

@@ -101,7 +101,7 @@ Returns `true` if the given "object" is a `RegExp`. `false` otherwise.
101101
// false
102102

103103

104-
### util.isDate(object)
104+
## util.isDate(object)
105105

106106
Returns `true` if the given "object" is a `Date`. `false` otherwise.
107107

@@ -115,7 +115,7 @@ Returns `true` if the given "object" is a `Date`. `false` otherwise.
115115
// false
116116

117117

118-
### util.isError(object)
118+
## util.isError(object)
119119

120120
Returns `true` if the given "object" is an `Error`. `false` otherwise.
121121

@@ -129,7 +129,7 @@ Returns `true` if the given "object" is an `Error`. `false` otherwise.
129129
// false
130130

131131

132-
### util.pump(readableStream, writableStream, [callback])
132+
## util.pump(readableStream, writableStream, [callback])
133133

134134
Experimental
135135

@@ -140,7 +140,7 @@ an error as its only argument and is called when `writableStream` is closed or
140140
when an error occurs.
141141

142142

143-
### util.inherits(constructor, superConstructor)
143+
## util.inherits(constructor, superConstructor)
144144

145145
Inherit the prototype methods from one
146146
[constructor](https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object/constructor)

0 commit comments

Comments
 (0)