summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat
-rw-r--r--doc/api/buffer.markdown6
-rw-r--r--doc/api/child_process.markdown24
-rw-r--r--doc/api/cluster.markdown18
-rw-r--r--doc/api/crypto.markdown34
-rw-r--r--doc/api/dgram.markdown53
-rw-r--r--doc/api/domain.markdown4
-rw-r--r--doc/api/fs.markdown14
-rw-r--r--doc/api/modules.markdown2
-rw-r--r--doc/api/net.markdown12
-rw-r--r--doc/api/stream.markdown29
-rw-r--r--doc/api_assets/style.css8
11 files changed, 104 insertions, 100 deletions
diff --git a/doc/api/buffer.markdown b/doc/api/buffer.markdown
index 4206d0778d..1da5bb83cb 100644
--- a/doc/api/buffer.markdown
+++ b/doc/api/buffer.markdown
@@ -473,7 +473,7 @@ console.log(buf1.equals(buf3));
### buf.fill(value[, offset[, end]])
-* `value` {String or Number}
+* `value` {String|Number}
* `offset` {Number} Default: 0
* `end` {Number} Default: `buffer.length`
* Return: {Buffer}
@@ -490,7 +490,7 @@ console.log(b.toString());
### buf.indexOf(value[, byteOffset][, encoding])
-* `value` {String, Buffer or Number}
+* `value` {String|Buffer|Number}
* `byteOffset` {Number} Default: 0
* `encoding` {String} Default: `'utf8'`
* Return: {Number}
@@ -527,7 +527,7 @@ utf16Buffer.indexOf('\u03a3', -4, 'ucs2');
### buf.includes(value[, byteOffset][, encoding])
-* `value` {String, Buffer or Number}
+* `value` {String|Buffer|Number}
* `byteOffset` {Number} Default: 0
* `encoding` {String} Default: `'utf8'`
* Return: {Boolean}
diff --git a/doc/api/child_process.markdown b/doc/api/child_process.markdown
index 65d7be99c6..3096fbb641 100644
--- a/doc/api/child_process.markdown
+++ b/doc/api/child_process.markdown
@@ -133,7 +133,7 @@ exec('my.bat', (err, stdout, stderr) => {
* `error` {Error}
* `stdout` {Buffer}
* `stderr` {Buffer}
-* Return: ChildProcess object
+* Return: {ChildProcess}
Spawns a shell then executes the `command` within that shell, buffering any
generated output.
@@ -200,7 +200,7 @@ replace the existing process and uses a shell to execute the command.*
* `error` {Error}
* `stdout` {Buffer}
* `stderr` {Buffer}
-* Return: ChildProcess object
+* Return: {ChildProcess}
The `child_process.execFile()` function is similar to [`child_process.exec()`][]
except that it does not spawn a shell. Rather, the specified executable `file`
@@ -236,7 +236,7 @@ const child = execFile('node', ['--version'], (error, stdout, stderr) => {
[`stdio`][] for more details (default is false)
* `uid` {Number} Sets the user identity of the process. (See setuid(2).)
* `gid` {Number} Sets the group identity of the process. (See setgid(2).)
-* Return: ChildProcess object
+* Return: {ChildProcess}
The `child_process.fork()` method is a special case of
[`child_process.spawn()`][] used specifically to spawn new Node.js processes.
@@ -282,7 +282,7 @@ not clone the current process.*
'/bin/sh' on UNIX, and 'cmd.exe' on Windows. A different shell can be
specified as a string. The shell should understand the `-c` switch on UNIX,
or `/s /c` on Windows. Defaults to `false` (no shell).
-* return: {ChildProcess object}
+* return: {ChildProcess}
The `child_process.spawn()` method spawns a new process using the given
`command`, with command line arguments in `args`. If omitted, `args` defaults
@@ -635,7 +635,7 @@ disconnecting it is no longer possible to send or receive messages, and the
### Event: 'error'
-* `err` {Error Object} the error.
+* `err` {Error} the error.
The `'error'` event is emitted whenever:
@@ -672,7 +672,7 @@ See `waitpid(2)`.
### Event: 'message'
* `message` {Object} a parsed JSON object or primitive value.
-* `sendHandle` {Handle object} a [`net.Socket`][] or [`net.Server`][] object, or
+* `sendHandle` {Handle} a [`net.Socket`][] or [`net.Server`][] object, or
undefined.
The `'message'` event is triggered when a child process uses `process.send()`
@@ -736,7 +736,7 @@ See `kill(2)`
### child.pid
-* {Integer}
+* {Number} Integer
Returns the process identifier (PID) of the child process.
@@ -753,9 +753,9 @@ grep.stdin.end();
### child.send(message[, sendHandle][, callback])
* `message` {Object}
-* `sendHandle` {Handle object}
+* `sendHandle` {Handle}
* `callback` {Function}
-* Return: Boolean
+* Return: {Boolean}
When an IPC channel has been established between the parent and child (
i.e. when using [`child_process.fork()`][]), the `child.send()` method can be
@@ -895,7 +895,7 @@ this occurs.
### child.stderr
-* {Stream object}
+* {Stream}
A `Readable Stream` that represents the child process's `stderr`.
@@ -907,7 +907,7 @@ the same value.
### child.stdin
-* {Stream object}
+* {Stream}
A `Writable Stream` that represents the child process's `stdin`.
@@ -959,7 +959,7 @@ assert.equal(child.stdio[2], child.stderr);
### child.stdout
-* {Stream object}
+* {Stream}
A `Readable Stream` that represents the child process's `stdout`.
diff --git a/doc/api/cluster.markdown b/doc/api/cluster.markdown
index f5bbafd810..215e48b12a 100644
--- a/doc/api/cluster.markdown
+++ b/doc/api/cluster.markdown
@@ -331,7 +331,7 @@ it is [`kill`][].
### worker.process
-* {ChildProcess object}
+* {ChildProcess}
All workers are created using [`child_process.fork()`][], the returned object
from this function is stored as `.process`. In a worker, the global `process`
@@ -346,7 +346,7 @@ disconnection.
### worker.send(message[, sendHandle][, callback])
* `message` {Object}
-* `sendHandle` {Handle object}
+* `sendHandle` {Handle}
* `callback` {Function}
* Return: Boolean
@@ -394,7 +394,7 @@ worker.kill();
## Event: 'disconnect'
-* `worker` {Worker object}
+* `worker` {cluster.Worker}
Emitted after the worker IPC channel has disconnected. This can occur when a
worker exits gracefully, is killed, or is disconnected manually (such as with
@@ -412,7 +412,7 @@ cluster.on('disconnect', (worker) => {
## Event: 'exit'
-* `worker` {Worker object}
+* `worker` {cluster.Worker}
* `code` {Number} the exit code, if it exited normally.
* `signal` {String} the name of the signal (eg. `'SIGHUP'`) that caused
the process to be killed.
@@ -433,7 +433,7 @@ See [child_process event: 'exit'][].
## Event: 'fork'
-* `worker` {Worker object}
+* `worker` {cluster.Worker}
When a new worker is forked the cluster module will emit a `'fork'` event.
This can be used to log worker activity, and create your own timeout.
@@ -458,7 +458,7 @@ cluster.on('exit', (worker, code, signal) => {
## Event: 'listening'
-* `worker` {Worker object}
+* `worker` {cluster.Worker}
* `address` {Object}
After calling `listen()` from a worker, when the `'listening'` event is emitted on
@@ -485,7 +485,7 @@ The `addressType` is one of:
## Event: 'message'
-* `worker` {Worker object}
+* `worker` {cluster.Worker}
* `message` {Object}
Emitted when any worker receives a message.
@@ -494,7 +494,7 @@ See [child_process event: 'message'][].
## Event: 'online'
-* `worker` {Worker object}
+* `worker` {cluster.Worker}
After forking a new worker, the worker should respond with an online message.
When the master receives an online message it will emit this event.
@@ -536,7 +536,7 @@ This can only be called from the master process.
## cluster.fork([env])
* `env` {Object} Key/value pairs to add to worker process environment.
-* return {Worker object}
+* return {cluster.Worker}
Spawn a new worker process.
diff --git a/doc/api/crypto.markdown b/doc/api/crypto.markdown
index e9d1df68d4..72f241b03a 100644
--- a/doc/api/crypto.markdown
+++ b/doc/api/crypto.markdown
@@ -722,8 +722,8 @@ The `private_key` argument can be an object or a string. If `private_key` is a
string, it is treated as a raw key with no passphrase. If `private_key` is an
object, it is interpreted as a hash containing two properties:
-* `key` : A string holding the PEM encoded private key
-* `passphrase` : A string of passphrase for the private key
+* `key` : {String} - PEM encoded private key
+* `passphrase` : {String} - passphrase for the private key
The `output_format` can specify one of `'binary'`, `'hex'` or `'base64'`. If
`output_format` is provided a string is returned; otherwise a [`Buffer`][] is
@@ -862,16 +862,16 @@ method should not be used.
The optional `details` argument is a hash object with keys:
-* `pfx` : A string or [`Buffer`][] holding the PFX or PKCS12 encoded private
+* `pfx` : {String|Buffer} - PFX or PKCS12 encoded private
key, certificate and CA certificates
-* `key` : A string holding the PEM encoded private key
-* `passphrase` : The string passphrase for the private key or PFX
-* `cert` : A string holding the PEM encoded certificate
-* `ca` : Either a string or array of strings of PEM encoded CA
+* `key` : {String} - PEM encoded private key
+* `passphrase` : {String} - passphrase for the private key or PFX
+* `cert` : {String} - PEM encoded certificate
+* `ca` : {String|Array} - Either a string or array of strings of PEM encoded CA
certificates to trust.
-* `crl` : Either a string or array of strings of PEM encoded CRLs
+* `crl` : {String|Array} - Either a string or array of strings of PEM encoded CRLs
(Certificate Revocation List)
-* `ciphers`: A string using the [OpenSSL cipher list format][] describing the
+* `ciphers`: {String} using the [OpenSSL cipher list format][] describing the
cipher algorithms to use or exclude.
If no 'ca' details are given, Node.js will use Mozilla's default
@@ -1144,8 +1144,8 @@ treated as the key with no passphrase and will use `RSA_PKCS1_OAEP_PADDING`.
If `private_key` is an object, it is interpreted as a hash object with the
keys:
-* `key` : A string holding the PEM encoded private key
-* `passphrase` : An optional string of passphrase for the private key
+* `key` : {String} - PEM encoded private key
+* `passphrase` : {String} - Optional passphrase for the private key
* `padding` : An optional padding value, one of the following:
* `constants.RSA_NO_PADDING`
* `constants.RSA_PKCS1_PADDING`
@@ -1162,8 +1162,8 @@ treated as the key with no passphrase and will use `RSA_PKCS1_PADDING`.
If `private_key` is an object, it is interpreted as a hash object with the
keys:
-* `key` : A string holding the PEM encoded private key
-* `passphrase` : An optional string of passphrase for the private key
+* `key` : {String} - PEM encoded private key
+* `passphrase` : {String} - Optional passphrase for the private key
* `padding` : An optional padding value, one of the following:
* `constants.RSA_NO_PADDING`
* `constants.RSA_PKCS1_PADDING`
@@ -1180,8 +1180,8 @@ treated as the key with no passphrase and will use `RSA_PKCS1_PADDING`.
If `public_key` is an object, it is interpreted as a hash object with the
keys:
-* `key` : A string holding the PEM encoded public key
-* `passphrase` : An optional string of passphrase for the private key
+* `key` : {String} - PEM encoded public key
+* `passphrase` : {String} - Optional passphrase for the private key
* `padding` : An optional padding value, one of the following:
* `constants.RSA_NO_PADDING`
* `constants.RSA_PKCS1_PADDING`
@@ -1201,8 +1201,8 @@ treated as the key with no passphrase and will use `RSA_PKCS1_OAEP_PADDING`.
If `public_key` is an object, it is interpreted as a hash object with the
keys:
-* `key` : A string holding the PEM encoded public key
-* `passphrase` : An optional string of passphrase for the private key
+* `key` : {String} - PEM encoded public key
+* `passphrase` : {String} - Optional passphrase for the private key
* `padding` : An optional padding value, one of the following:
* `constants.RSA_NO_PADDING`
* `constants.RSA_PKCS1_PADDING`
diff --git a/doc/api/dgram.markdown b/doc/api/dgram.markdown
index 905897630c..fc6e256c70 100644
--- a/doc/api/dgram.markdown
+++ b/doc/api/dgram.markdown
@@ -43,7 +43,7 @@ Once triggered, no new `'message'` events will be emitted on this socket.
### Event: 'error'
-* `exception` Error object
+* `exception` {Error}
The `'error'` event is emitted whenever any error occurs. The event handler
function is passed a single Error object.
@@ -55,8 +55,8 @@ datagram messages. This occurs as soon as UDP sockets are created.
### Event: 'message'
-* `msg` Buffer object. The message
-* `rinfo` Object. Remote address information
+* `msg` {Buffer} - The message
+* `rinfo` {Object} - Remote address information
The `'message'` event is emitted when a new datagram is available on a socket.
The event handler function is passed two arguments: `msg` and `rinfo`. The
@@ -72,8 +72,8 @@ socket.on('message', (msg, rinfo) => {
### socket.addMembership(multicastAddress[, multicastInterface])
-* `multicastAddress` String
-* `multicastInterface` String, Optional
+* `multicastAddress` {String}
+* `multicastInterface` {String}, Optional
Tells the kernel to join a multicast group at the given `multicastAddress`
using the `IP_ADD_MEMBERSHIP` socket option. If the `multicastInterface`
@@ -88,9 +88,9 @@ properties.
### socket.bind([port][, address][, callback])
-* `port` Integer, Optional
-* `address` String, Optional
-* `callback` Function with no parameters, Optional. Called when
+* `port` {Number} - Integer, Optional
+* `address` {String}, Optional
+* `callback` {Function} with no parameters, Optional. Called when
binding is complete.
For UDP sockets, causes the `dgram.Socket` to listen for datagram messages on a
@@ -174,8 +174,8 @@ provided, it is added as a listener for the [`'close'`][] event.
### socket.dropMembership(multicastAddress[, multicastInterface])
-* `multicastAddress` String
-* `multicastInterface` String, Optional
+* `multicastAddress` {String}
+* `multicastInterface` {String}, Optional
Instructs the kernel to leave a multicast group at `multicastAddress` using the
`IP_DROP_MEMBERSHIP` socket option. This method is automatically called by the
@@ -187,13 +187,12 @@ drop membership on all valid interfaces.
### socket.send(msg, [offset, length,] port, address[, callback])
-* `msg` Buffer object, string, or an array of either. Message to be
- sent.
-* `offset` Integer. Optional. Offset in the buffer where the message starts.
-* `length` Integer. Optional. Number of bytes in the message.
-* `port` Integer. Destination port.
-* `address` String. Destination hostname or IP address.
-* `callback` Function. Called when the message has been sent. Optional.
+* `buf` {Buffer|String|Array} Message to be sent
+* `offset` {Number} Integer. Optional. Offset in the buffer where the message starts.
+* `length` {Number} Integer. Optional. Number of bytes in the message.
+* `port` {Number} Integer. Destination port.
+* `address` {String} Destination hostname or IP address.
+* `callback` {Function} Called when the message has been sent. Optional.
Broadcasts a datagram on the socket. The destination `port` and `address` must
be specified.
@@ -288,21 +287,21 @@ source that the data did not reach its intended recipient.
### socket.setBroadcast(flag)
-* `flag` Boolean
+* `flag` {Boolean}
Sets or clears the `SO_BROADCAST` socket option. When set to `true`, UDP
packets may be sent to a local interface's broadcast address.
### socket.setMulticastLoopback(flag)
-* `flag` Boolean
+* `flag` {Boolean}
Sets or clears the `IP_MULTICAST_LOOP` socket option. When set to `true`,
multicast packets will also be received on the local interface.
### socket.setMulticastTTL(ttl)
-* `ttl` Integer
+* `ttl` {Number} Integer
Sets the `IP_MULTICAST_TTL` socket option. While TTL generally stands for
"Time to Live", in this context it specifies the number of IP hops that a
@@ -315,7 +314,7 @@ between 0 and 255. The default on most systems is `1` but can vary.
### socket.setTTL(ttl)
-* `ttl` Integer
+* `ttl` {Number} Integer
Sets the `IP_TTL` socket option. While TTL generally stands for "Time to Live",
in this context it specifies the number of IP hops that a packet is allowed to
@@ -378,9 +377,9 @@ s.bind(1234, () => {
### dgram.createSocket(options[, callback])
-* `options` Object
-* `callback` Function. Attached as a listener to `'message'` events.
-* Returns: Socket object
+* `options` {Object}
+* `callback` {Function} Attached as a listener to `'message'` events.
+* Returns: {dgram.Socket}
Creates a `dgram.Socket` object. The `options` argument is an object that
should contain a `type` field of either `udp4` or `udp6` and an optional
@@ -400,10 +399,10 @@ and `udp6` sockets). The bound address and port can be retrieved using
### dgram.createSocket(type[, callback])
-* `type` String. Either 'udp4' or 'udp6'
-* `callback` Function. Attached as a listener to `'message'` events.
+* `type` {String} - Either 'udp4' or 'udp6'
+* `callback` {Function} - Attached as a listener to `'message'` events.
Optional
-* Returns: Socket object
+* Returns: {dgram.Socket}
Creates a `dgram.Socket` object of the specified `type`. The `type` argument
can be either `udp4` or `udp6`. An optional `callback` function can be passed
diff --git a/doc/api/domain.markdown b/doc/api/domain.markdown
index 9321b38506..41d27c5625 100644
--- a/doc/api/domain.markdown
+++ b/doc/api/domain.markdown
@@ -313,7 +313,7 @@ to the domain.
### domain.add(emitter)
-* `emitter` {EventEmitter | Timer} emitter or timer to be added to the domain
+* `emitter` {EventEmitter|Timer} emitter or timer to be added to the domain
Explicitly adds an emitter to the domain. If any event handlers called by
the emitter throw an error, or if the emitter emits an `'error'` event, it
@@ -329,7 +329,7 @@ from that one, and bound to this one instead.
### domain.remove(emitter)
-* `emitter` {EventEmitter | Timer} emitter or timer to be removed from the domain
+* `emitter` {EventEmitter|Timer} emitter or timer to be removed from the domain
The opposite of [`domain.add(emitter)`][]. Removes domain handling from the
specified emitter.
diff --git a/doc/api/fs.markdown b/doc/api/fs.markdown
index fe109d2482..0740fda91b 100644
--- a/doc/api/fs.markdown
+++ b/doc/api/fs.markdown
@@ -108,7 +108,7 @@ See more details in [`fs.watch()`][].
### Event: 'error'
-* `error` {Error object}
+* `error` {Error}
Emitted when an error occurs.
@@ -122,7 +122,7 @@ Stop watching for changes on the given `fs.FSWatcher`.
### Event: 'open'
-* `fd` {Integer} file descriptor used by the ReadStream.
+* `fd` {Number} Integer file descriptor used by the ReadStream.
Emitted when the ReadStream's file is opened.
@@ -205,7 +205,7 @@ on Unix systems, it never was.
### Event: 'open'
-* `fd` {Integer} file descriptor used by the WriteStream.
+* `fd` {Number} Integer file descriptor used by the WriteStream.
Emitted when the WriteStream's file is opened.
@@ -251,10 +251,10 @@ fail, and does nothing otherwise.
## fs.appendFile(file, data[, options], callback)
-* `file` {String | Integer} filename or file descriptor
-* `data` {String | Buffer}
-* `options` {Object | String}
- * `encoding` {String | Null} default = `'utf8'`
+* `file` {String|Number} filename or file descriptor
+* `data` {String|Buffer}
+* `options` {Object|String}
+ * `encoding` {String|Null} default = `'utf8'`
* `mode` {Number} default = `0o666`
* `flag` {String} default = `'a'`
* `callback` {Function}
diff --git a/doc/api/modules.markdown b/doc/api/modules.markdown
index 376feb33df..bd715f9fec 100644
--- a/doc/api/modules.markdown
+++ b/doc/api/modules.markdown
@@ -528,7 +528,7 @@ loading.
### module.parent
-* {Module Object}
+* {Object} Module object
The module that first required this one.
diff --git a/doc/api/net.markdown b/doc/api/net.markdown
index 1cd14b563f..2f41a0dfab 100644
--- a/doc/api/net.markdown
+++ b/doc/api/net.markdown
@@ -19,14 +19,14 @@ event is not emitted until all connections are ended.
### Event: 'connection'
-* {Socket object} The connection object
+* {net.Socket} The connection object
Emitted when a new connection is made. `socket` is an instance of
`net.Socket`.
### Event: 'error'
-* {Error Object}
+* {Error}
Emitted when an error occurs. The [`'close'`][] event will be called directly
following this event. See example in discussion of `server.listen`.
@@ -275,7 +275,7 @@ See [`connect()`][].
### Event: 'data'
-* {Buffer object}
+* {Buffer}
Emitted when data is received. The argument `data` will be a `Buffer` or
`String`. Encoding of data is set by `socket.setEncoding()`.
@@ -302,7 +302,7 @@ caveat that the user is required to `end()` their side now.
### Event: 'error'
-* {Error object}
+* {Error}
Emitted when an error occurs. The `'close'` event will be called directly
following this event.
@@ -312,9 +312,9 @@ following this event.
Emitted after resolving the hostname but before connecting.
Not applicable to UNIX sockets.
-* `err` {Error | Null} The error object. See [`dns.lookup()`][].
+* `err` {Error|Null} The error object. See [`dns.lookup()`][].
* `address` {String} The IP address.
-* `family` {String | Null} The address type. See [`dns.lookup()`][].
+* `family` {String|Null} The address type. See [`dns.lookup()`][].
### Event: 'timeout'
diff --git a/doc/api/stream.markdown b/doc/api/stream.markdown
index 4cab811205..4f8be5025c 100644
--- a/doc/api/stream.markdown
+++ b/doc/api/stream.markdown
@@ -164,7 +164,7 @@ Not all streams will emit the `'close'` event.
#### Event: 'data'
-* `chunk` {Buffer | String} The chunk of data.
+* `chunk` {Buffer|String} The chunk of data.
Attaching a `'data'` event listener to a stream that has not been
explicitly paused will switch the stream into flowing mode. Data will
@@ -254,7 +254,7 @@ end
#### readable.isPaused()
-* Return: `Boolean`
+* Return: {Boolean}
This method returns whether or not the `readable` has been **explicitly**
paused by client code (using [`stream.pause()`][stream-pause] without a
@@ -293,7 +293,7 @@ readable.on('data', (chunk) => {
#### readable.pipe(destination[, options])
-* `destination` {[Writable][] Stream} The destination for writing data
+* `destination` {stream.Writable} The destination for writing data
* `options` {Object} Pipe options
* `end` {Boolean} End the writer when the reader ends. Default = `true`
@@ -346,7 +346,7 @@ the process exits, regardless of the specified options.
#### readable.read([size])
* `size` {Number} Optional argument to specify how much data to read.
-* Return {String | Buffer | null}
+* Return {String|Buffer|Null}
The `read()` method pulls some data out of the internal buffer and
returns it. If there is no data available, then it will return
@@ -427,7 +427,7 @@ readable.on('data', (chunk) => {
#### readable.unpipe([destination])
-* `destination` {[Writable][] Stream} Optional specific stream to unpipe
+* `destination` {stream.Writable} Optional specific stream to unpipe
This method will remove the hooks set up for a previous [`stream.pipe()`][]
call.
@@ -453,7 +453,7 @@ setTimeout(() => {
#### readable.unshift(chunk)
-* `chunk` {Buffer | String} Chunk of data to unshift onto the read queue
+* `chunk` {Buffer|String} Chunk of data to unshift onto the read queue
This is useful in certain cases where a stream is being consumed by a
parser, which needs to "un-consume" some data that it has
@@ -605,7 +605,7 @@ function writeOneMillionTimes(writer, data, encoding, callback) {
#### Event: 'error'
-* {Error object}
+* {Error}
Emitted if there was an error when writing or piping data.
@@ -627,7 +627,7 @@ writer.on('finish', () => {
#### Event: 'pipe'
-* `src` {[Readable][] Stream} source stream that is piping to this writable
+* `src` {stream.Readable} source stream that is piping to this writable
This is emitted whenever the [`stream.pipe()`][] method is called on a readable
stream, adding this writable to its set of destinations.
@@ -670,7 +670,7 @@ Buffered data will be flushed either at [`stream.uncork()`][] or at
#### writable.end([chunk][, encoding][, callback])
-* `chunk` {String | Buffer} Optional data to write
+* `chunk` {String|Buffer} Optional data to write
* `encoding` {String} The encoding, if `chunk` is a String
* `callback` {Function} Optional callback for when the stream is finished
@@ -700,7 +700,7 @@ Flush all data, buffered since [`stream.cork()`][] call.
#### writable.write(chunk[, encoding][, callback])
-* `chunk` {String | Buffer} The data to write
+* `chunk` {String|Buffer} The data to write
* `encoding` {String} The encoding, if `chunk` is a String
* `callback` {Function} Callback for when this chunk of data is flushed
* Returns: {Boolean} `true` if the data was handled completely.
@@ -901,8 +901,9 @@ becomes available. There is no need, for example to "wait" until
#### readable.push(chunk[, encoding])
-* `chunk` {Buffer | null | String} Chunk of data to push into the read queue
-* `encoding` {String} Encoding of String chunks. Must be a valid
+
+* `chunk` {Buffer|Null|String} Chunk of data to push into the read queue
+* `encoding` {String} Encoding of String chunks. Must be a valid
Buffer encoding, such as `'utf8'` or `'ascii'`
* return {Boolean} Whether or not more pushes should be performed
@@ -1167,7 +1168,7 @@ your own extension classes.
#### transform.\_transform(chunk, encoding, callback)
-* `chunk` {Buffer | String} The chunk to be transformed. Will **always**
+* `chunk` {Buffer|String} The chunk to be transformed. Will **always**
be a buffer unless the `decodeStrings` option was set to `false`.
* `encoding` {String} If the chunk is a string, then this is the
encoding type. If chunk is a buffer, then this is the special
@@ -1328,7 +1329,7 @@ initialized.
#### writable.\_write(chunk, encoding, callback)
-* `chunk` {Buffer | String} The chunk to be written. Will **always**
+* `chunk` {Buffer|String} The chunk to be written. Will **always**
be a buffer unless the `decodeStrings` option was set to `false`.
* `encoding` {String} If the chunk is a string, then this is the
encoding type. If chunk is a buffer, then this is the special
diff --git a/doc/api_assets/style.css b/doc/api_assets/style.css
index 99bed0e761..714fada4f9 100644
--- a/doc/api_assets/style.css
+++ b/doc/api_assets/style.css
@@ -349,8 +349,12 @@ a code {
background: inherit;
}
-span.type {
- color: #222;
+span.type, a.type {
+ font-size: 0.9em;
+ padding: 0.2em 0.4em;
+ line-height: 1.5em;
+ font-family: Monaco, Consolas, "Lucida Console", monospace;
+ margin: 0;
}
#content {
generated by cgit v1.2.3 (git 2.39.1) at 2024-05-17 09:32:09 +0000