Node.js v6.17.1 Documentation

Table of Contents

• About this Documentation
  • Contributing
  • Stability Index
  • JSON Output
  • Syscalls and man pages
• Usage
  • Example
• C++ Addons
  • Hello world
    • Building
    • Linking to Node.js' own dependencies
    • Loading Addons using require()
  • Native Abstractions for Node.js
  • N-API
  • 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(message)
  • assert.fail(actual, expected[, message[, operator[, stackStartFunction]]])
  • 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()
    • The --zero-fill-buffers command line option
    • What makes Buffer.allocUnsafe() and Buffer.allocUnsafeSlow() "unsafe"?
  • Buffers and Character Encodings
  • Buffers and TypedArray
  • Buffers and ES6 iteration
  • Class: Buffer
    • new Buffer(array)
    • new Buffer(buffer)
    • new Buffer(arrayBuffer[, byteOffset [, length]])
    • new Buffer(size)
    • new Buffer(string[, 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[, byteOffset[, length]])
    • Class Method: Buffer.from(buffer)
    • Class Method: Buffer.from(string[, encoding])
    • Class Method: Buffer.isBuffer(obj)
    • Class Method: Buffer.isEncoding(encoding)
    • Class Property: Buffer.poolSize
    • buf[index]
    • buf.compare(target[, targetStart[, targetEnd[, sourceStart[, sourceEnd]]]])
    • buf.copy(target[, targetStart[, sourceStart[, sourceEnd]]])
    • buf.entries()
    • buf.equals(otherBuffer)
    • buf.fill(value[, offset[, end]][, encoding])
    • buf.includes(value[, byteOffset][, encoding])
    • buf.indexOf(value[, byteOffset][, encoding])
    • buf.includes(value[, byteOffset][, encoding])
    • buf.keys()
    • buf.lastIndexOf(value[, byteOffset][, encoding])
    • 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.swap16()
    • buf.swap32()
    • buf.swap64()
    • 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
  • buffer.kMaxLength
  • 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
  • maxBuffer and Unicode
• Cluster
  • How It Works
  • Class: Worker
    • Event: 'disconnect'
    • Event: 'error'
    • Event: 'exit'
    • Event: 'listening'
    • Event: 'message'
    • Event: 'online'
    • worker.disconnect()
    • worker.exitedAfterDisconnect
    • 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
    • --no-warnings
    • --trace-warnings
    • --redirect-warnings=file
    • --trace-sync-io
    • --zero-fill-buffers
    • --preserve-symlinks
    • --track-heap-objects
    • --prof-process
    • --v8-options
    • --tls-cipher-list=list
    • --enable-fips
    • --force-fips
    • --openssl-config=file
    • --use-openssl-ca, --use-bundled-ca
    • --icu-data-dir=file
    • --
    • --max-http-header-size=size
  • Environment Variables
    • NODE_DEBUG=module[,…]
    • NODE_PATH=path[:…]
    • NODE_DISABLE_COLORS=1
    • NODE_ICU_DATA=file
    • NODE_NO_WARNINGS=1
    • NODE_OPTIONS=options...
    • NODE_REPL_HISTORY=file
    • NODE_TTY_UNSAFE_ASYNC=1
    • NODE_EXTRA_CA_CERTS=file
    • OPENSSL_CONF=file
    • SSL_CERT_DIR=dir
    • SSL_CERT_FILE=file
    • NODE_REDIRECT_WARNINGS=file
• Console
  • Class: Console
    • new Console(stdout[, stderr])
    • console.assert(value[, message][, ...args])
    • console.clear()
    • console.count([label])
    • console.countReset([label = 'default'])
    • console.dir(obj[, options])
    • console.error([data][, ...args])
    • console.info([data][, ...args])
    • console.log([data][, ...args])
    • console.time(label)
    • console.timeEnd(label)
    • console.trace(message[, ...args])
    • console.warn([data][, ...args])
• Crypto
  • Determining if crypto support is unavailable
  • 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)