Node.js v4.9.1 Documentation

Table of Contents

• About this Documentation
  • Stability Index
  • JSON Output
  • Syscalls and man pages
• Usage
  • Example
• C/C++ Addons
  • Hello world
    • Building
    • Linking to Node.js' own dependencies
    • Loading Addons using require()
  • Native Abstractions for Node.js
  • Addon examples
    • Function arguments
    • Callbacks
    • Object factory
    • Function factory
    • Wrapping C++ objects
    • Factory of wrapped objects
    • Passing wrapped objects around
    • AtExit hooks
      • void AtExit(callback, args)
• Assert
  • assert(value[, message])
  • assert.deepEqual(actual, expected[, message])
  • assert.deepStrictEqual(actual, expected[, message])
  • assert.doesNotThrow(block[, error][, message])
  • assert.equal(actual, expected[, message])
  • assert.fail(actual, expected, message, operator)
  • assert.ifError(value)
  • assert.notDeepEqual(actual, expected[, message])
  • assert.notDeepStrictEqual(actual, expected[, message])
  • assert.notEqual(actual, expected[, message])
  • assert.notStrictEqual(actual, expected[, message])
  • assert.ok(value[, message])
  • assert.strictEqual(actual, expected[, message])
  • assert.throws(block[, error][, message])
• Buffer
  • Buffer.from(), Buffer.alloc(), and Buffer.allocUnsafe()
    • What makes Buffer.allocUnsafe(size) and Buffer.allocUnsafeSlow(size) "unsafe"?
  • Buffers and Character Encodings
  • Buffers and TypedArray
  • Buffers and ES6 iteration
  • The --zero-fill-buffers command line option
  • Class: Buffer
    • new Buffer(array)
    • new Buffer(buffer)
    • new Buffer(arrayBuffer)
    • new Buffer(size)
    • new Buffer(str[, encoding])
    • Class Method: Buffer.alloc(size[, fill[, encoding]])
    • Class Method: Buffer.allocUnsafe(size)
    • Class Method: Buffer.allocUnsafeSlow(size)
    • Class Method: Buffer.byteLength(string[, encoding])
    • Class Method: Buffer.compare(buf1, buf2)
    • Class Method: Buffer.concat(list[, totalLength])
    • Class Method: Buffer.from(array)
    • Class Method: Buffer.from(arrayBuffer)
    • Class Method: Buffer.from(buffer)
    • Class Method: Buffer.from(str[, encoding])
    • Class Method: Buffer.isBuffer(obj)
    • Class Method: Buffer.isEncoding(encoding)
    • buf[index]
    • buf.compare(otherBuffer)
    • buf.copy(targetBuffer[, targetStart[, sourceStart[, sourceEnd]]])
    • buf.entries()
    • buf.equals(otherBuffer)
    • buf.fill(value[, offset[, end]])
    • buf.indexOf(value[, byteOffset][, encoding])
    • buf.keys()
    • buf.length
    • buf.readDoubleBE(offset[, noAssert])
    • buf.readDoubleLE(offset[, noAssert])
    • buf.readFloatBE(offset[, noAssert])
    • buf.readFloatLE(offset[, noAssert])
    • buf.readInt8(offset[, noAssert])
    • buf.readInt16BE(offset[, noAssert])
    • buf.readInt16LE(offset[, noAssert])
    • buf.readInt32BE(offset[, noAssert])
    • buf.readInt32LE(offset[, noAssert])
    • buf.readIntBE(offset, byteLength[, noAssert])
    • buf.readIntLE(offset, byteLength[, noAssert])
    • buf.readUInt8(offset[, noAssert])
    • buf.readUInt16BE(offset[, noAssert])
    • buf.readUInt16LE(offset[, noAssert])
    • buf.readUInt32BE(offset[, noAssert])
    • buf.readUInt32LE(offset[, noAssert])
    • buf.readUIntBE(offset, byteLength[, noAssert])
    • buf.readUIntLE(offset, byteLength[, noAssert])
    • buf.slice([start[, end]])
    • buf.toString([encoding[, start[, end]]])
    • buf.toJSON()
    • buf.values()
    • buf.write(string[, offset[, length]][, encoding])
    • buf.writeDoubleBE(value, offset[, noAssert])
    • buf.writeDoubleLE(value, offset[, noAssert])
    • buf.writeFloatBE(value, offset[, noAssert])
    • buf.writeFloatLE(value, offset[, noAssert])
    • buf.writeInt8(value, offset[, noAssert])
    • buf.writeInt16BE(value, offset[, noAssert])
    • buf.writeInt16LE(value, offset[, noAssert])
    • buf.writeInt32BE(value, offset[, noAssert])
    • buf.writeInt32LE(value, offset[, noAssert])
    • buf.writeIntBE(value, offset, byteLength[, noAssert])
    • buf.writeIntLE(value, offset, byteLength[, noAssert])
    • buf.writeUInt8(value, offset[, noAssert])
    • buf.writeUInt16BE(value, offset[, noAssert])
    • buf.writeUInt16LE(value, offset[, noAssert])
    • buf.writeUInt32BE(value, offset[, noAssert])
    • buf.writeUInt32LE(value, offset[, noAssert])
    • buf.writeUIntBE(value, offset, byteLength[, noAssert])
    • buf.writeUIntLE(value, offset, byteLength[, noAssert])
  • buffer.INSPECT_MAX_BYTES
  • Class: SlowBuffer
    • new SlowBuffer(size)
• Child Process
  • Asynchronous Process Creation
    • Spawning .bat and .cmd files on Windows
    • child_process.exec(command[, options][, callback])
    • child_process.execFile(file[, args][, options][, callback])
    • child_process.fork(modulePath[, args][, options])
    • child_process.spawn(command[, args][, options])
      • options.detached
      • options.stdio
  • Synchronous Process Creation
    • child_process.execFileSync(file[, args][, options])
    • child_process.execSync(command[, options])
    • child_process.spawnSync(command[, args][, options])
  • Class: ChildProcess
    • Event: 'close'
    • Event: 'disconnect'
    • Event: 'error'
    • Event: 'exit'
    • Event: 'message'
    • subprocess.connected
    • subprocess.disconnect()
    • subprocess.kill([signal])
    • subprocess.killed
    • subprocess.pid
    • subprocess.send(message[, sendHandle[, options]][, callback])
      • Example: sending a server object
      • Example: sending a socket object
    • subprocess.stderr
    • subprocess.stdin
    • subprocess.stdio
    • subprocess.stdout
• Cluster
  • How It Works
  • Class: Worker
    • Event: 'disconnect'
    • Event: 'error'
    • Event: 'exit'
    • Event: 'listening'
    • Event: 'message'
    • Event: 'online'
    • worker.disconnect()
    • worker.id
    • worker.isConnected()
    • worker.isDead()
    • worker.kill([signal='SIGTERM'])
    • worker.process
    • worker.send(message[, sendHandle][, callback])
    • worker.suicide
  • Event: 'disconnect'
  • Event: 'exit'
  • Event: 'fork'
  • Event: 'listening'
  • Event: 'message'
  • Event: 'online'
  • Event: 'setup'
  • cluster.disconnect([callback])
  • cluster.fork([env])
  • cluster.isMaster
  • cluster.isWorker
  • cluster.schedulingPolicy
  • cluster.settings
  • cluster.setupMaster([settings])
  • cluster.worker
  • cluster.workers
• Command Line Options
  • Synopsis
  • Options
    • -v, --version
    • -h, --help
    • -e, --eval "script"
    • -p, --print "script"
    • -c, --check
    • -i, --interactive
    • -r, --require module
    • --no-deprecation
    • --trace-deprecation
    • --throw-deprecation
    • --trace-sync-io
    • --zero-fill-buffers
    • --track-heap-objects
    • --prof-process
    • --v8-options
    • --tls-cipher-list=list
    • --enable-fips
    • --force-fips
    • --icu-data-dir=file
  • Environment Variables
    • NODE_DEBUG=module[,…]
    • NODE_PATH=path[:…]
    • NODE_DISABLE_COLORS=1
    • NODE_ICU_DATA=file
    • NODE_REPL_HISTORY=file
    • NODE_EXTRA_CA_CERTS=file
• Console
  • Asynchronous vs Synchronous Consoles
  • Class: Console
    • new Console(stdout[, stderr])
    • console.assert(value[, message][, ...])
    • console.dir(obj[, options])
    • console.error([data][, ...])
    • console.info([data][, ...])
    • console.log([data][, ...])
    • console.time(label)
    • console.timeEnd(label)
    • console.trace(message[, ...])
    • console.warn([data][, ...])
• Crypto
  • Class: Certificate
    • new crypto.Certificate()
    • certificate.exportChallenge(spkac)
    • certificate.exportPublicKey(spkac)
    • certificate.verifySpkac(spkac)
  • Class: Cipher
    • cipher.final([output_encoding])
    • cipher.setAAD(buffer)
    • cipher.getAuthTag()
    • cipher.setAutoPadding(auto_padding=true)
    • cipher.update(data[, input_encoding][, output_encoding])
  • Class: Decipher
    • decipher.final([output_encoding])
    • decipher.setAAD(buffer)
    • decipher.setAuthTag(buffer)
    • decipher.setAutoPadding(auto_padding=true)
    • decipher.update(data[, input_encoding][, output_encoding])
  • Class: DiffieHellman
    • diffieHellman.computeSecret(other_public_key[, input_encoding][, output_encoding])
    • diffieHellman.generateKeys([encoding])
    • diffieHellman.getGenerator([encoding])
    • diffieHellman.getPrime([encoding])
    • diffieHellman.getPrivateKey([encoding])
    • diffieHellman.getPublicKey([encoding])
    • diffieHellman.setPrivateKey(private_key[, encoding])
    • diffieHellman.setPublicKey(public_key[, encoding])
    • diffieHellman.verifyError
  • Class: ECDH
    • ecdh.computeSecret(other_public_key[, input_encoding][, output_encoding])
    • ecdh.generateKeys([encoding[, format]])
    • ecdh.getPrivateKey([encoding])
    • ecdh.getPublicKey([encoding[, format]])
    • ecdh.setPrivateKey(private_key[, encoding])
    • ecdh.setPublicKey(public_key[, encoding])
  • Class: Hash
    • hash.digest([encoding])
    • hash.update(data[, input_encoding])
  • Class: Hmac
    • hmac.digest([encoding])
    • hmac.update(data[, input_encoding])
  • Class: Sign
    • sign.sign(private_key[, output_format])
    • sign.update(data[, input_encoding])
  • Class: Verify
    • verifier.update(data[, input_encoding])
    • verifier.verify(object, signature[, signature_format])
  • crypto module methods and properties
    • crypto.DEFAULT_ENCODING
    • crypto.createCipher(algorithm, password)
    • crypto.createCipheriv(algorithm, key, iv)
    • crypto.createCredentials(details)
    • crypto.createDecipher(algorithm, password)
    • crypto.createDecipheriv(algorithm, key, iv)
    • crypto.createDiffieHellman(prime[, prime_encoding][, generator][, generator_encoding])
    • crypto.createDiffieHellman(prime_length[, generator])
    • crypto.createECDH(curve_name)
    • crypto.createHash(algorithm)
    • crypto.createHmac(algorithm, key)
    • crypto.createSign(algorithm)
    • crypto.createVerify(algorithm)
    • crypto.getCiphers()
    • crypto.getCurves()
    • crypto.getDiffieHellman(group_name)
    • crypto.getHashes()
    • crypto.pbkdf2(password, salt, iterations, keylen[, digest], callback)
    • crypto.pbkdf2Sync(password, salt, iterations, keylen[, digest])
    • crypto.privateDecrypt(private_key, buffer)
    • crypto.privateEncrypt(private_key, buffer)
    • crypto.publicDecrypt(public_key, buffer)
    • crypto.publicEncrypt(public_key, buffer)
    • crypto.randomBytes(size[, callback])
    • crypto.setEngine(engine[, flags])
  • Notes
    • Legacy Streams API (pre Node.js v0.10)
    • Recent ECDH Changes
    • Support for weak or compromised algorithms
• Debugger
  • Watchers
  • Command reference
    • Stepping
    • Breakpoints
    • Information
    • Execution control
    • Various
  • Advanced Usage
• UDP / Datagram Sockets
  • Class: dgram.Socket
    • Event: 'close'
    • Event: 'error'
    • Event: 'listening'
    • Event: 'message'
    • socket.addMembership(multicastAddress[, multicastInterface])
    • socket.address()
    • socket.bind([port][, address][, callback])
    • socket.bind(options[, callback])
    • socket.close([callback])
    • socket.dropMembership(multicastAddress[, multicastInterface])
    • socket.send(buf, offset, length, port, address[, callback])
    • socket.setBroadcast(flag)
    • socket.setMulticastLoopback(flag)
    • socket.setMulticastTTL(ttl)
    • socket.setTTL(ttl)
    • socket.ref()
    • socket.unref()
    • Change to asynchronous socket.bind() behavior
  • dgram module functions
    • dgram.createSocket(options[, callback])
    • dgram.createSocket(type[, callback])
• DNS
  • dns.getServers()
  • dns.lookup(hostname[, options], callback)
    • Supported getaddrinfo flags
  • dns.lookupService(address, port, callback)
  • dns.resolve(hostname[, rrtype], callback)
  • dns.resolve4(hostname, callback)
  • dns.resolve6(hostname, callback)
  • dns.resolveCname(hostname, callback)
  • dns.resolveMx(hostname, callback)
  • dns.resolveNaptr(hostname, callback)
  • dns.resolveNs(hostname, callback)
  • dns.resolveSoa(hostname, callback)
  • dns.resolveSrv(hostname, callback)
  • dns.resolveTxt(hostname, callback)
  • dns.reverse(ip, callback)
  • dns.setServers(servers)
  • Error codes
  • Implementation considerations
    • dns.lookup()
    • dns.resolve(), dns.resolve*() and dns.reverse()
• Domain
  • Warning: Don't Ignore Errors!
  • Additions to Error objects
  • Implicit Binding
  • Explicit Binding
  • domain.create()
  • Class: Domain
    • domain.run(fn[, arg][, ...])
    • domain.members
    • domain.add(emitter)
    • domain.remove(emitter)
    • domain.bind(callback)
      • Example
    • domain.intercept(callback)
      • Example
    • domain.enter()
    • domain.exit()
    • domain.dispose()
• Errors
  • Error Propagation and Interception
    • Node.js style callbacks
  • Class: Error
    • new Error(message)
    • Error.captureStackTrace(targetObject[, constructorOpt])
    • Error.stackTraceLimit
      • error.message
      • error.stack
  • Class: RangeError
  • Class: ReferenceError
  • Class: SyntaxError
  • Class: TypeError
  • Exceptions vs. Errors
  • System Errors
    • Class: System Error
      • error.code
      • error.errno
      • error.syscall
      • error.path
      • error.address
      • error.port
    • Common System Errors
• Events
  • Passing arguments and this to listeners
  • Asynchronous vs. Synchronous
  • Handling events only once
  • Error events
  • Class: EventEmitter
    • Event: 'newListener'
    • Event: 'removeListener'
    • EventEmitter.listenerCount(emitter, eventName)
    • EventEmitter.defaultMaxListeners
    • emitter.addListener(eventName, listener)
    • emitter.emit(eventName[, arg1][, arg2][, ...])
    • emitter.getMaxListeners()
    • emitter.listenerCount(eventName)
    • emitter.listeners(eventName)
    • emitter.on(eventName, listener)
    • emitter.once(eventName, listener)
    • emitter.removeAllListeners([eventName])
    • emitter.removeListener(eventName, listener)
    • emitter.setMaxListeners(n)
• File System
  • Class: fs.FSWatcher
    • Event: 'change'
    • Event: 'error'
    • watcher.close()
  • Class: fs.ReadStream
    • Event: 'open'
    • Event: 'close'
    • readStream.path
  • Class: fs.Stats
    • Stat Time Values
  • Class: fs.WriteStream
    • Event: 'open'
    • Event: 'close'
    • writeStream.bytesWritten
    • writeStream.path
  • fs.access(path[, mode], callback)
  • fs.accessSync(path[, mode])
  • fs.appendFile(file, data[, options], callback)
  • fs.appendFileSync(file, data[, options])
  • fs.chmod(path, mode, callback)
  • fs.chmodSync(path, mode)
  • fs.chown(path, uid, gid, callback)
  • fs.chownSync(path, uid, gid)
  • fs.close(fd, callback)
  • fs.closeSync(fd)
  • fs.createReadStream(path[, options])
  • fs.createWriteStream(path[, options])
  • fs.exists(path, callback)
  • fs.existsSync(path)
  • fs.fchmod(fd, mode, callback)
  • fs.fchmodSync(fd, mode)
  • fs.fchown(fd, uid, gid, callback)
  • fs.fchownSync(fd, uid, gid)
  • fs.fdatasync(fd, callback)
  • fs.fdatasyncSync(fd)
  • fs.fstat(fd, callback)
  • fs.fstatSync(fd)
  • fs.fsync(fd, callback)
  • fs.fsyncSync(fd)
  • fs.ftruncate(fd, len, callback)
  • fs.ftruncateSync(fd, len)
  • fs.futimes(fd, atime, mtime, callback)
  • fs.futimesSync(fd, atime, mtime)
  • fs.lchmod(path, mode, callback)
  • fs.lchmodSync(path, mode)
  • fs.lchown(path, uid, gid, callback)
  • fs.lchownSync(path, uid, gid)
  • fs.link(srcpath, dstpath, callback)
  • fs.linkSync(srcpath, dstpath)
  • fs.lstat(path, callback)
  • fs.lstatSync(path)
  • fs.mkdir(path[, mode], callback)
  • fs.mkdirSync(path[, mode])
  • fs.mkdtemp(prefix, callback)
  • fs.mkdtempSync(template)
  • fs.open(path, flags[, mode], callback)
  • fs.openSync(path, flags[, mode])
  • fs.read(fd, buffer, offset, length, position, callback)
  • fs.readdir(path, callback)
  • fs.readdirSync(path)
  • fs.readFile(file[, options], callback)
  • fs.readFileSync(file[, options])
  • fs.readlink(path, callback)
  • fs.readlinkSync(path)
  • fs.realpath(path[, cache], callback)
  • fs.readSync(fd, buffer, offset, length, position)
  • fs.realpathSync(path[, cache])
  • fs.rename(oldPath, newPath, callback)
  • fs.renameSync(oldPath, newPath)
  • fs.rmdir(path, callback)
  • fs.rmdirSync(path)
  • fs.stat(path, callback)
  • fs.statSync(path)
  • fs.symlink(target, path[, type], callback)
  • fs.symlinkSync(target, path[, type])
  • fs.truncate(path, len, callback)
  • fs.truncateSync(path, len)
  • fs.unlink(path, callback)
  • fs.unlinkSync(path)
  • fs.unwatchFile(filename[, listener])
  • fs.utimes(path, atime, mtime, callback)
  • fs.utimesSync(path, atime, mtime)
  • fs.watch(filename[, options][, listener])
    • Caveats
      • Availability
      • Inodes
      • Filename Argument
  • fs.watchFile(filename[, options], listener)
  • fs.write(fd, buffer, offset, length[, position], callback)
  • fs.write(fd, data[, position[, encoding]], callback)
  • fs.writeFile(file, data[, options], callback)
  • fs.writeFileSync(file, data[, options])
  • fs.writeSync(fd, buffer, offset, length[, position])
  • fs.writeSync(fd, data[, position[, encoding]])
• Global Objects
  • Class: Buffer
  • __dirname
  • __filename
  • clearImmediate(immediateObject)
  • clearInterval(intervalObject)
  • clearTimeout(timeoutObject)
  • console
  • exports
  • global
  • module
  • process
  • require()
    • require.cache
    • require.extensions
    • require.resolve()
  • setImmediate(callback[, arg][, ...])
  • setInterval(callback, delay[, arg][, ...])
  • setTimeout(callback, delay[, arg][, ...])
• HTTP
  • Class: http.Agent
    • new Agent([options])
    • agent.destroy()
    • agent.freeSockets
    • agent.getName(options)
    • agent.maxFreeSockets
    • agent.maxSockets
    • agent.requests
    • agent.sockets
  • Class: http.ClientRequest
    • Event: 'abort'
    • Event: 'aborted'
    • Event: 'connect'
    • Event: 'continue'
    • Event: 'response'
    • Event: 'socket'
    • Event: 'upgrade'
    • request.abort()
    • request.aborted
    • request.end([data][, encoding][, callback])
    • request.flushHeaders()
    • request.setNoDelay([noDelay])
    • request.setSocketKeepAlive([enable][, initialDelay])
    • request.setTimeout(timeout[, callback])
    • request.write(chunk[, encoding][, callback])
  • Class: http.Server
    • Event: 'checkContinue'
    • Event: 'clientError'
    • Event: 'close'
    • Event: 'connect'
    • Event: 'connection'
    • Event: 'request'
    • Event: 'upgrade'
    • server.close([callback])
    • server.listen(handle[, callback])
    • server.listen(path[, callback])
    • server.listen([port][, hostname][, backlog][, callback])
    • server.maxHeadersCount
    • server.setTimeout(msecs, callback)
    • server.timeout
  • Class: http.ServerResponse
    • Event: 'close'
    • Event: 'finish'
    • response.addTrailers(headers)
    • response.end([data][, encoding][, callback])
    • response.finished
    • response.getHeader(name)
    • response.headersSent
    • response.removeHeader(name)
    • response.sendDate
    • response.setHeader(name, value)
    • response.setTimeout(msecs, callback)
    • response.statusCode
    • response.statusMessage
    • response.write(chunk[, encoding][, callback])
    • response.writeContinue()
    • response.writeHead(statusCode[, statusMessage][, headers])
  • Class: http.IncomingMessage
    • Event: 'aborted'
    • Event: 'close'
    • message.destroy([error])
    • message.headers
    • message.httpVersion
    • message.method
    • message.rawHeaders
    • message.rawTrailers
    • message.setTimeout(msecs, callback)
    • message.statusCode
    • message.statusMessage
    • message.socket
    • message.trailers
    • message.url
  • http.METHODS
  • http.STATUS_CODES
  • http.createClient([port][, host])
  • http.createServer([requestListener])
  • http.get(options[, callback])
  • http.globalAgent
  • http.request(options[, callback])
• HTTPS
  • Class: https.Agent
  • Class: https.Server
    • server.setTimeout(msecs, callback)
    • server.timeout
  • https.createServer(options[, requestListener])
    • server.close([callback])
    • server.listen(handle[, callback])
    • server.listen(path[, callback])
    • server.listen(port[, host][, backlog][, callback])
  • https.get(options, callback)
  • https.globalAgent
  • https.request(options, callback)
• Modules
  • Accessing the main module
  • Addenda: Package Manager Tips
  • All Together...
  • Caching
    • Module Caching Caveats
  • Core Modules
  • Cycles
  • File Modules
  • Folders as Modules
  • Loading from node_modules Folders
  • Loading from the global folders
  • The module wrapper
  • The module Object
    • module.children
    • module.exports
      • exports shortcut
    • module.filename
    • module.id
    • module.loaded
    • module.parent
    • module.require(id)
• Net
  • Class: net.Server
    • Event: 'close'
    • Event: 'connection'
    • Event: 'error'
    • Event: 'listening'
    • server.address()
    • server.close([callback])
    • server.connections
    • server.getConnections(callback)
    • server.listen(handle[, backlog][, callback])
    • server.listen(options[, callback])
    • server.listen(path[, backlog][, callback])
    • server.listen([port][, hostname][, backlog][, callback])
    • server.maxConnections
    • server.ref()
    • server.unref()
  • Class: net.Socket
    • new net.Socket([options])
    • Event: 'close'
    • Event: 'connect'
    • Event: 'data'
    • Event: 'drain'
    • Event: 'end'
    • Event: 'error'
    • Event: 'lookup'
    • Event: 'timeout'
    • socket.address()
    • socket.bufferSize
    • socket.bytesRead
    • socket.bytesWritten
    • socket.connect(options[, connectListener])
    • socket.connect(path[, connectListener])
    • socket.connect(port[, host][, connectListener])
    • socket.destroy()
    • socket.destroyed
    • socket.end([data][, encoding])
    • socket.localAddress
    • socket.localPort
    • socket.pause()
    • socket.ref()
    • socket.remoteAddress
    • socket.remoteFamily
    • socket.remotePort
    • socket.resume()
    • socket.setEncoding([encoding])
    • socket.setKeepAlive([enable][, initialDelay])
    • socket.setNoDelay([noDelay])
    • socket.setTimeout(timeout[, callback])
    • socket.unref()
    • socket.write(data[, encoding][, callback])
  • net.connect(options[, connectListener])
  • net.connect(path[, connectListener])
  • net.connect(port[, host][, connectListener])
  • net.createConnection(options[, connectListener])
  • net.createConnection(path[, connectListener])
  • net.createConnection(port[, host][, connectListener])
  • net.createServer([options][, connectionListener])
  • net.isIP(input)
  • net.isIPv4(input)
  • net.isIPv6(input)
• OS
  • os.EOL
  • os.arch()
  • os.cpus()
  • os.endianness()
  • os.freemem()
  • os.homedir()
  • os.hostname()
  • os.loadavg()
  • os.networkInterfaces()
  • os.platform()
  • os.release()
  • os.tmpdir()
  • os.totalmem()
  • os.type()
  • os.uptime()
• Path
  • path.basename(p[, ext])
  • path.delimiter
  • path.dirname(p)
  • path.extname(p)
  • path.format(pathObject)
  • path.isAbsolute(path)
  • path.join([path1][, path2][, ...])
  • path.normalize(p)
  • path.parse(pathString)
  • path.posix
  • path.relative(from, to)
  • path.resolve([from ...], to)
  • path.sep
  • path.win32
• Process
  • Event: 'beforeExit'
  • Event: 'exit'
  • Event: 'message'
  • Event: 'rejectionHandled'
  • Event: 'uncaughtException'
    • Warning: Using 'uncaughtException' correctly
  • Event: 'unhandledRejection'
  • Exit Codes
  • Signal Events
  • process.abort()
  • process.arch
  • process.argv
  • process.chdir(directory)
  • process.config
  • process.connected
  • process.cpuUsage([previousValue])
  • process.cwd()
  • process.disconnect()
  • process.env
  • process.execArgv
  • process.execPath
  • process.exit([code])
  • process.exitCode
  • process.getegid()
  • process.geteuid()
  • process.getgid()
  • process.getgroups()
  • process.getuid()
  • process.hrtime()
  • process.initgroups(user, extra_group)
  • process.kill(pid[, signal])
  • process.mainModule
  • process.memoryUsage()
  • process.nextTick(callback[, arg][, ...])
  • process.pid
  • process.platform
  • process.release
  • process.send(message[, sendHandle][, callback])
  • process.setegid(id)
  • process.seteuid(id)
  • process.setgid(id)
  • process.setgroups(groups)
  • process.setuid(id)
  • process.stderr
  • process.stdin
  • process.stdout
  • process.title
  • process.umask([mask])
  • process.uptime()
  • process.version
  • process.versions
• Punycode
  • punycode.decode(string)
  • punycode.encode(string)
  • punycode.toASCII(domain)
  • punycode.toUnicode(domain)
  • punycode.ucs2
    • punycode.ucs2.decode(string)
    • punycode.ucs2.encode(codePoints)
  • punycode.version
• Query String
  • querystring.escape
  • querystring.parse(str[, sep][, eq][, options])
  • querystring.stringify(obj[, sep][, eq][, options])
  • querystring.unescape
• Readline
  • Class: Interface
    • rl.close()
    • rl.pause()
    • rl.prompt([preserveCursor])
    • rl.question(query, callback)
    • rl.resume()
    • rl.setPrompt(prompt)
    • rl.write(data[, key])
  • Events
    • Event: 'close'
    • Event: 'line'
    • Event: 'pause'
    • Event: 'resume'
    • Event: 'SIGCONT'
    • Event: 'SIGINT'
    • Event: 'SIGTSTP'
  • Example: Tiny CLI
  • Example: Read File Stream Line-by-Line
  • readline.clearLine(stream, dir)
  • readline.clearScreenDown(stream)
  • readline.createInterface(options)
  • readline.cursorTo(stream, x, y)
  • readline.emitKeypressEvents(stream[, interface])
  • readline.moveCursor(stream, dx, dy)
• REPL
  • Environment Variable Options
  • Persistent History
    • NODE_REPL_HISTORY_FILE
  • REPL Features
    • Customizing Object displays in the REPL
  • Class: REPLServer
    • Event: 'exit'
    • Event: 'reset'
    • replServer.defineCommand(keyword, cmd)
    • replServer.displayPrompt([preserveCursor])
  • repl.start(options)
• Stream
  • API for Stream Consumers
    • Class: stream.Duplex
    • Class: stream.Readable
      • Event: 'close'
      • Event: 'data'
      • Event: 'end'
      • Event: 'error'
      • Event: 'readable'
      • readable.isPaused()
      • readable.pause()
      • readable.pipe(destination[, options])
      • readable.read([size])
      • readable.resume()
      • readable.setEncoding(encoding)
      • readable.unpipe([destination])
      • readable.unshift(chunk)
      • readable.wrap(stream)
    • Class: stream.Transform
    • Class: stream.Writable
      • Event: 'close'
      • Event: 'drain'
      • Event: 'error'
      • Event: 'finish'
      • Event: 'pipe'
      • Event: 'unpipe'
      • writable.cork()
      • writable.end([chunk][, encoding][, callback])
      • writable.setDefaultEncoding(encoding)
      • writable.uncork()
      • writable.write(chunk[, encoding][, callback])
  • API for Stream Implementors
    • Class: stream.Duplex
      • new stream.Duplex(options)
    • Class: stream.PassThrough
    • Class: stream.Readable
      • new stream.Readable([options])
      • readable._read(size)
      • readable.push(chunk[, encoding])
      • Example: A Counting Stream
      • Example: SimpleProtocol v1 (Sub-optimal)
    • Class: stream.Transform
      • new stream.Transform([options])
      • Events: 'finish' and 'end'
      • transform._flush(callback)
      • transform._transform(chunk, encoding, callback)
      • Example: SimpleProtocol parser v2
    • Class: stream.Writable
      • new stream.Writable([options])
      • writable._write(chunk, encoding, callback)
      • writable._writev(chunks, callback)
  • Simplified Constructor API
    • Duplex
    • Readable
    • Transform
    • Writable
  • Streams: Under the Hood
    • Buffering
    • Compatibility with Older Node.js Versions
    • Object Mode
    • stream.read(0)
    • stream.push('')
• String Decoder
  • Class: StringDecoder
    • decoder.end()
    • decoder.write(buffer)
• Timers
  • clearImmediate(immediateObject)
  • clearInterval(intervalObject)
  • clearTimeout(timeoutObject)
  • ref()
  • setImmediate(callback[, arg][, ...])
  • setInterval(callback, delay[, arg][, ...])
  • setTimeout(callback, delay[, arg][, ...])
  • unref()
• TLS (SSL)
  • Client-initiated renegotiation attack mitigation
  • Modifying the Default TLS Cipher suite
  • ALPN, NPN and SNI
  • Perfect Forward Secrecy
  • Class: CryptoStream
    • cryptoStream.bytesWritten
  • Class: SecurePair
    • Event: 'secure'
  • Class: tls.Server
    • Event: 'clientError'
    • Event: 'newSession'
    • Event: 'OCSPRequest'
    • Event: 'resumeSession'
    • Event: 'secureConnection'
    • server.addContext(hostname, context)
    • server.address()
    • server.close([callback])
    • server.connections
    • server.getTicketKeys()
    • server.listen(port[, hostname][, callback])
    • server.maxConnections
    • server.setTicketKeys(keys)
  • Class: tls.TLSSocket
  • new tls.TLSSocket(socket[, options])
    • Event: 'OCSPResponse'