doc: fix sorting in API references
Checklist
-
documentation is changed or added -
commit message follows commit guidelines
Affected core subsystem(s)
doc
Some chapters in the API lists were out of alphabetical order due to different adding time or preferring logical order (open
before close
, unref()
next to ref()
and so on). However, docs prefer alphabetical order in the most cases, so such exceptions could be confusing and could prevent a reader from finding a needed chapter.
I've abstained from changing an unalphabetical order in two docs: cli.md
(it seems to be mostly logical) and zlib.md
(due to only one description for async and sync pairs of "Convenience Methods").
Relocated chapters (because of mutual relocations some other ones could seem relocated too):
buffer.md
new Buffer(arrayBuffer[, byteOffset [, length]])
(compare the place of: Class Method: Buffer.from(arrayBuffer[, byteOffset[, length]]))
buf.includes(value[, byteOffset][, encoding])
buf.toJSON()
crypto.md
crypto.timingSafeEqual(a, b)
dns.md
dns.resolvePtr(hostname, callback)
domain.md many
fs.md
Class: fs.ReadStream
— Event: 'close'
Class: fs.WriteStream
— Event: 'close'
http.md
message.socket
process.md
process.env
tls.md
Class: tls.Server
— Event: 'tlsClientError'
Class: tls.TLSSocket
— tlsSocket.authorized
tls.connect(port[, host][, options][, callback])
tls.connect(path[, options][, callback])
dgram.md
socket.ref()
url.md
many of urlObject.*
util.md
util.inspect.custom
util._extend(target, source)
v8.md
v8.getHeapSpaceStatistics()
You can easily see these order violations in the tables of content from the relevant .html files.