Creates and returns a cipher object with the given algorithm and password.\n
\n", "fargs": [ { "id": "algorithm", "type": [ "es5:Object/prototype" ] }, { "id": "password", "type": [ "es5:Object/prototype" ] } ] } ], "_createCipheriv": [ { "guid": "nodejs_latest:crypto/createCipheriv[0]", "properties": { "_return": [ "nodejs_latest:crypto/cipher/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/crypto.html#crypto.createCipheriv", "doc": "Creates and returns a cipher object, with the given algorithm, key, and IV.\n
\n", "fargs": [ { "id": "algorithm", "type": [ "es5:Object/prototype" ] }, { "id": "key", "type": [ "es5:Object/prototype" ] }, { "id": "iv", "type": [ "es5:Object/prototype" ] } ] } ], "_createCredentials": [ { "guid": "nodejs_latest:crypto/createCredentials[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/crypto.html#crypto.createCredentials", "doc": "Creates a credentials object, with details being a dictionary with the\nfollowing keys:\n
Creates and returns a decipher object, with the given algorithm and key.
\n", "fargs": [ { "id": "algorithm", "type": [ "es5:Object/prototype" ] }, { "id": "password", "type": [ "es5:Object/prototype" ] } ] } ], "_createDecipheriv": [ { "guid": "nodejs_latest:crypto/createDecipheriv[0]", "properties": { "_return": [ "nodejs_latest:crypto/decipher/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/crypto.html#crypto.createDecipheriv", "doc": "Creates and returns a decipher object, with the given algorithm, key, and iv.
\n", "fargs": [ { "id": "algorithm", "type": [ "es5:Object/prototype" ] }, { "id": "key", "type": [ "es5:Object/prototype" ] }, { "id": "iv", "type": [ "es5:Object/prototype" ] } ] } ], "_createDiffieHellman": [ { "guid": "nodejs_latest:crypto/createDiffieHellman[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/crypto.html#crypto.createDiffieHellman", "doc": "Creates a Diffie-Hellman key exchange object and generates a prime of the given\nbit length. The generator used is 2.\n
Creates and returns a cryptographic hash object with the given algorithm. The\nobject can be used to generate hash digests.\n
\n", "fargs": [ { "id": "algorithm", "type": [ "es5:Object/prototype" ] } ] } ], "_createHmac": [ { "guid": "nodejs_latest:crypto/createHmac[0]", "properties": { "_return": [ "nodejs_latest:crypto/hmac/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/crypto.html#crypto.createHmac", "doc": "Creates and returns a cryptographic HMAC object with the given algorithm and\nkey. For more information on HMAC, see this\narticle.\n
\n", "fargs": [ { "id": "algorithm", "type": [ "es5:Object/prototype" ] }, { "id": "key", "type": [ "es5:Object/prototype" ] } ] } ], "_createSign": [ { "guid": "nodejs_latest:crypto/createSign[0]", "properties": { "_return": [ "nodejs_latest:crypto/signer/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/crypto.html#crypto.createSign", "doc": "Creates and returns a signing object string, with the given algorithm.
Creates and returns a verification object, with the given algorithm.\n
\n", "fargs": [ { "id": "algorithim", "type": [ "es5:Object/prototype" ] } ] } ], "_getDiffieHellman": [ { "guid": "nodejs_latest:crypto/getDiffieHellman[0]", "properties": { "_return": [ "nodejs_latest:crypto/diffieHellman/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/crypto.html#crypto.getDiffieHellman", "doc": "Creates a predefined Diffie-Hellman key exchange object.\n
\n", "fargs": [ { "id": "group_name", "type": [ "es5:Object/prototype" ] } ] } ], "_pbkdf2": [ { "guid": "nodejs_latest:crypto/pbkdf2[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/crypto.html#crypto.pbkdf2", "doc": "An asynchronous PBKDF2 function that applies pseudorandom function HMAC-SHA1 to\nderive a key of the given length from the given password, salt, and number of\niterations.\n
\n", "fargs": [ { "id": "password", "type": [ "es5:Object/prototype" ] }, { "id": "salt", "type": [ "es5:Object/prototype" ] }, { "id": "iterations", "type": [ "es5:Object/prototype" ] }, { "id": "keylen", "type": [ "es5:Object/prototype" ] }, { "id": "callback", "type": [ "es5:Object/prototype" ], "fargs": [ { "id": "err", "type": [ "es5:Error/prototype" ] }, { "id": "derivedKey", "type": [ "es5:String/prototype" ] } ] } ] } ], "_randomBytes": [ { "guid": "nodejs_latest:crypto/randomBytes[0]", "properties": { "_return": [ "es5:String/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/crypto.html#crypto.randomBytes", "doc": "Generates cryptographically strong pseudo-random data, either asynchronously or\nsynchronously.\n
\n", "fargs": [ { "id": "size", "type": [ "es5:Object/prototype" ] }, { "id": "callback", "type": [ "es5:Object/prototype" ], "opt": true, "fargs": [ { "id": "ex", "type": [ "es5:Error/prototype" ] }, { "id": "buf", "type": [ "es5:String/prototype" ] } ] } ] } ] }, "kind": "package", "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/crypto.html#crypto", "doc": "The crypto module offers a way of encapsulating secure credentials to be used\nas part of a secure HTTPS net or HTTP connection. To access this module, add\nrequire('crypto') to your code.\n
Tests if value is a true value. This is equivalent to assert.equal(true,\nvalue, message). This is the same as assert.ok(), except that message is\nrequired.
Tests for deep equality.
\n", "fargs": [ { "id": "actual", "type": [ "es5:Object/prototype" ] }, { "id": "expected", "type": [ "es5:Object/prototype" ] }, { "id": "message", "type": [ "es5:Object/prototype" ], "opt": true } ] } ], "_doesNotThrow": [ { "guid": "nodejs_latest:assert/doesNotThrow[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/assert.html#assert.doesNotThrow", "doc": "Expects block not to throw an error; for more details, see assert.throws().
Tests shallow, coercive equality with the equal comparison operator ( == ).
Throws an exception that displays the values for actual and expected\nseparated by the provided operator.\n
Tests if value is false; throws an error if it is true. Useful when testing\nthe first argument, error, in callbacks.
Tests for any deep inequality.
\n", "fargs": [ { "id": "actual", "type": [ "es5:Object/prototype" ] }, { "id": "expected", "type": [ "es5:Object/prototype" ] }, { "id": "message", "type": [ "es5:Object/prototype" ], "opt": true } ] } ], "_notEqual": [ { "guid": "nodejs_latest:assert/notEqual[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/assert.html#assert.notEqual", "doc": "Tests shallow, coercive non-equality with the not equal comparison operator (\n!= ).
Tests strict non-equality, as determined by the strict not equal operator (\n!== ).
Tests if value is a true value. This is equivalent to assert.equal(true,\nvalue, message);. This is the same as assert(), except that message is not\nrequired.
Tests strict equality, as determined by the strict equality operator ( === ).
If blockthrows an error, then the assertion passes.\n
All of the assert methods basically compare two different states—an expected\none, and an actual one—and return a Boolean condition. If the comparisson is\ntrue, the condition passes. If an assert method is false, the entire Node.js\napp crashes.\n
The number of characters written by buffer.write(). This\nvalue is overwritten each time buffer.write() is called.
Performs a copy between buffers. The source and target regions can overlap.\n
\n", "fargs": [ { "id": "targetBuffer", "type": [ "es5:Object/prototype" ] }, { "id": "targetStart", "type": [ "es5:Object/prototype" ] }, { "id": "sourceStart", "type": [ "es5:Object/prototype" ] }, { "id": "sourceEnd", "type": [ "es5:Object/prototype" ] } ] } ], "_fill": [ { "guid": "nodejs_latest:Buffer/prototype/fill[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/buffer.html#Buffer.fill", "doc": "Fills the buffer with the specified value. If the offset and end are not given,\nthis fills the entire buffer.\n
\n", "fargs": [ { "id": "value", "type": [ "es5:Object/prototype" ] }, { "id": "offset", "type": [ "es5:Object/prototype" ] }, { "id": "end", "type": [ "es5:Object/prototype" ] } ] } ], "_index": [ { "guid": "nodejs_latest:Buffer/prototype/index[0]", "properties": { "___proto__": [ "es5:Number/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/buffer.html#Buffer.index", "doc": "Gets and sets the octet at index in an array format. The values refer to\nindividual bytes, so the legal range is between 0x00 and 0xFF hex or 0 and\n255.\n
Returns true if obj is a Buffer.
The size of the buffer in bytes. Note that this is not necessarily the size of\nthe contents. length refers to the amount of memory allocated for the buffer\nobject. It does not change when the contents of the buffer are changed.\n
Allocates a new buffer object.\n
\n", "fargs": [] } ], "_readDoubleBE": [ { "guid": "nodejs_latest:Buffer/prototype/readDoubleBE[0]", "properties": { "_return": [ "es5:String/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/buffer.html#Buffer.readDoubleBE", "doc": "Reads a 64-bit double from the buffer at the specified offset in big endian\nnotation.\n
\n", "fargs": [ { "id": "offset", "type": [ "es5:Object/prototype" ] }, { "id": "noAssert", "type": [ "es5:Object/prototype" ] } ] } ], "_readDoubleLE": [ { "guid": "nodejs_latest:Buffer/prototype/readDoubleLE[0]", "properties": { "_return": [ "es5:String/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/buffer.html#Buffer.readDoubleLE", "doc": "Reads a 64 bit double from the buffer at the specified offset in little endian\nnotation.\n
\n", "fargs": [ { "id": "offset", "type": [ "es5:Object/prototype" ] }, { "id": "noAssert", "type": [ "es5:Object/prototype" ] } ] } ], "_readFloatBE": [ { "guid": "nodejs_latest:Buffer/prototype/readFloatBE[0]", "properties": { "_return": [ "es5:String/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/buffer.html#Buffer.readFloatBE", "doc": "Reads a 32 bit float from the buffer at the specified offset in big endian\nnotation.\n
\n", "fargs": [ { "id": "offset", "type": [ "es5:Object/prototype" ] }, { "id": "noAssert", "type": [ "es5:Object/prototype" ] } ] } ], "_readFloatLE": [ { "guid": "nodejs_latest:Buffer/prototype/readFloatLE[0]", "properties": { "_return": [ "es5:String/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/buffer.html#Buffer.readFloatLE", "doc": "Reads a 32 bit float from the buffer at the specified offset in little endian\nnotation.\n
\n", "fargs": [ { "id": "offset", "type": [ "es5:Object/prototype" ] }, { "id": "noAssert", "type": [ "es5:Object/prototype" ] } ] } ], "_readInt16BE": [ { "guid": "nodejs_latest:Buffer/prototype/readInt16BE[0]", "properties": { "_return": [ "es5:String/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/buffer.html#Buffer.readInt16BE", "doc": "Reads a signed 16 bit integer from the buffer at the specified offset in big\nendian notation.\n
\n", "fargs": [ { "id": "offset", "type": [ "es5:Object/prototype" ] }, { "id": "noAssert", "type": [ "es5:Object/prototype" ] } ] } ], "_readInt16LE": [ { "guid": "nodejs_latest:Buffer/prototype/readInt16LE[0]", "properties": { "_return": [ "es5:String/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/buffer.html#Buffer.readInt16LE", "doc": "Reads a signed 16 bit integer from the buffer at the specified offset in little\nendian notation.\n
\n", "fargs": [ { "id": "offset", "type": [ "es5:Object/prototype" ] }, { "id": "noAssert", "type": [ "es5:Object/prototype" ] } ] } ], "_readInt32BE": [ { "guid": "nodejs_latest:Buffer/prototype/readInt32BE[0]", "properties": { "_return": [ "es5:String/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/buffer.html#Buffer.readInt32BE", "doc": "Reads a signed 32-bit integer from the buffer at the specified offset in big\nendian notation.\n
\n", "fargs": [ { "id": "offset", "type": [ "es5:Object/prototype" ] }, { "id": "noAssert", "type": [ "es5:Object/prototype" ] } ] } ], "_readInt32LE": [ { "guid": "nodejs_latest:Buffer/prototype/readInt32LE[0]", "properties": { "_return": [ "es5:String/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/buffer.html#Buffer.readInt32LE", "doc": "Reads a signed 32 bit integer from the buffer at the specified offset in little\nendian notation.\n
\n", "fargs": [ { "id": "offset", "type": [ "es5:Object/prototype" ] }, { "id": "noAssert", "type": [ "es5:Object/prototype" ] } ] } ], "_readInt8": [ { "guid": "nodejs_latest:Buffer/prototype/readInt8[0]", "properties": { "_return": [ "es5:String/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/buffer.html#Buffer.readInt8", "doc": "Reads a signed 8 bit integer from the buffer at the specified offset.\n
\n", "fargs": [ { "id": "offset", "type": [ "es5:Object/prototype" ] }, { "id": "noAssert", "type": [ "es5:Object/prototype" ] } ] } ], "_readUInt16BE": [ { "guid": "nodejs_latest:Buffer/prototype/readUInt16BE[0]", "properties": { "_return": [ "es5:String/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/buffer.html#Buffer.readUInt16BE", "doc": "Reads an unsigned 16 bit integer from the buffer at the specified offset in the\nbig endian format.\n
\n", "fargs": [ { "id": "offset", "type": [ "es5:Object/prototype" ] }, { "id": "noAssert", "type": [ "es5:Object/prototype" ] } ] } ], "_readUInt16LE": [ { "guid": "nodejs_latest:Buffer/prototype/readUInt16LE[0]", "properties": { "_return": [ "es5:String/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/buffer.html#Buffer.readUInt16LE", "doc": "Reads an unsigned 16 bit integer from the buffer at the specified offset in the\nlittle endian format.\n
\n", "fargs": [ { "id": "offset", "type": [ "es5:Object/prototype" ] }, { "id": "noAssert", "type": [ "es5:Object/prototype" ] } ] } ], "_readUInt32BE": [ { "guid": "nodejs_latest:Buffer/prototype/readUInt32BE[0]", "properties": { "_return": [ "es5:String/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/buffer.html#Buffer.readUInt32BE", "doc": "Reads an unsigned 32 bit integer from the buffer at the specified offset in the\nbig endian format.\n
\n", "fargs": [ { "id": "offset", "type": [ "es5:Object/prototype" ] }, { "id": "noAssert", "type": [ "es5:Object/prototype" ] } ] } ], "_readUInt32LE": [ { "guid": "nodejs_latest:Buffer/prototype/readUInt32LE[0]", "properties": { "_return": [ "es5:String/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/buffer.html#Buffer.readUInt32LE", "doc": "Reads an unsigned 32 bit integer from the buffer at the specified offset in the\nlittle endian format.\n
\n", "fargs": [ { "id": "offset", "type": [ "es5:Object/prototype" ] }, { "id": "noAssert", "type": [ "es5:Object/prototype" ] } ] } ], "_readUInt8": [ { "guid": "nodejs_latest:Buffer/prototype/readUInt8[0]", "properties": { "_return": [ "es5:String/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/buffer.html#Buffer.readUInt8", "doc": "Reads an unsigned 8 bit integer from the buffer at the specified offset.\n
\n", "fargs": [ { "id": "offset", "type": [ "es5:Object/prototype" ] }, { "id": "noAssert", "type": [ "es5:Object/prototype" ] } ] } ], "_slice": [ { "guid": "nodejs_latest:Buffer/prototype/slice[0]", "properties": { "_return": [ "nodejs_latest:Buffer/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/buffer.html#Buffer.slice", "doc": "Returns a new buffer that references the same memory as the old, but offset and\ncropped by the start and end indexes.\n
Decodes and returns a string from buffer data encoded with encoding beginning\nat start and ending at end.
Writes a string to the buffer at offset using the given encoding. length\nis the number of bytes to write. If buffer does not contain enough space to\nfit the entire string, it instead writes a partial amount of the string. The\nmethod doesn't write partial characters.\n
Writes value to the buffer at the specified offset in the big endian format.\nNote that value must be a valid 64 bit double.\n
Writes value to the buffer at the specified offset in the little endian\nformat. Note that value must be a valid 64 bit double.\n
Writes value to the buffer at the specified offset in the big endian format.\nNote that value must be a valid 32 bit float.\n
Writes value to the buffer at the specified offset in the little endian\nformat. Note that value must be a valid 32 bit float.\n
Writes value to the buffer at the specified offset in the big endian format.\nNote that value must be a valid signed 16 bit integer.\n
Writes value to the buffer at the specified offset in the little endian\nformat. Note that value must be a valid signed 16 bit integer.\n
Writes value to the buffer at the specified offset in the big endian format.\nNote that value must be a valid signed 32 bit integer.\n
Writes value to the buffer at the specified offset in the little endian\nformat. Note that value must be a valid signed 32 bit integer.\n
Writes value to the buffer at the specified offset. Note that value must be\na valid signed 8 bit integer.\n
Writes value to the buffer at the specified offset in the big endian format.\nNote that value must be a valid unsigned 16 bit integer.\n
Writes value to the buffer at the specified offset in the little endian\nformat. Note that value must be a valid unsigned 16 bit integer.\n
Writes value to the buffer at the specified offset in the big endian format.\nNote that value must be a valid unsigned 32 bit integer.\n
Writes value to the buffer at the specified offset in the little endian\nformat. Note that value must be a valid unsigned 32 bit integer.\n
Writes value to the buffer at the specified offset. Note that value must be\na valid unsigned 8 bit integer.\n
The number of bytes returned when buffer.inspect() is called; the default is\n50. This can be overridden by user modules.
Pure Javascript is Unicode friendly, but not nice to binary data. When dealing\nwith TCP streams or the file system, it's often necessary to handle octet\nstreams. Node has several strategies for manipulating, creating, and consuming\noctet streams.\n
\n", "fargs": [] }, "nodejs_latest:child_process": { "guid": "nodejs_latest:child_process", "properties": { "_prototype": [ { "guid": "nodejs_latest:child_process/prototype", "properties": {} } ], "_exec": [ { "guid": "nodejs_latest:child_process/exec[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/child_process.html#child_process.exec", "doc": "Runs a Unix command in a shell and buffers the output.\n
\n", "fargs": [ { "id": "command", "type": [ "es5:Object/prototype" ] }, { "id": "options", "type": [ "es5:Object/prototype" ], "opt": true }, { "id": "callback", "type": [ "es5:Object/prototype" ], "fargs": [ { "id": "error", "type": [ "es5:Error/prototype" ] }, { "id": "stdout", "type": [ [ "nodejs_latest:streams/ReadableStream/prototype" ] ] }, { "id": "stderr", "type": [ [ "nodejs_latest:streams/ReadableStream/prototype" ] ] } ] } ] } ], "_execFile": [ { "guid": "nodejs_latest:child_process/execFile[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/child_process.html#child_process.execFile", "doc": "A function similar to child.exec(), except instead of executing a subshell it\nexecutes the specified file directly. This makes it slightly leaner than\nchild.exec. It has the same options and callback.
This is a special case of the child_process.spawn()\nfunctionality for spawning Node.js processes. In addition to having all the\nmethods in a normal ChildProcess instance, the returned object has a\ncommunication channel built-in. The channel is written with child.send(message,\n[sendHandle]), and messages are recieved by a 'message' event on the child.\n
Sends a signal to the child process. See\nsignal(7) for a list of available signals.\n
The PID of the child process.\n
\n" } ], "_spawn": [ { "guid": "nodejs_latest:child_process/spawn[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/child_process.html#child_process.spawn", "doc": "Launches a new process for the given Unix command. You can pass command line\narguments through args. options specifies additional options, which default\nto:\n
A Writable Stream that represents the child\nprocess's stdin. Closing this stream via streams.WritableStream.end() often causes the child process to terminate.
A Readable Stream that represents the child\nprocess's stdout.
Node.js provides a tri-directional\npopen(3)\nfacility through the child_process module. It's possible to stream data\nthrough the child's stdin, stdout, and stderr in a fully non-blocking way.\n
When calling this method, all workers will commit a graceful suicide. After they\nare disconnected, all internal handlers will be closed, allowing the master\nprocess to die graceful if no other event is waiting.
\n", "fargs": [ { "id": "callback", "type": [ "es5:Object/prototype" ], "opt": true } ] } ], "_fork": [ { "guid": "nodejs_latest:cluster/fork[0]", "properties": { "_return": [ "nodejs_latest:worker/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/cluster.html#cluster.fork", "doc": "Spawns a new worker process. This can only be called from the master process.\n
\n", "fargs": [ { "id": "env", "type": [ "es5:Object/prototype" ], "opt": true } ] } ], "_isMaster": [ { "guid": "nodejs_latest:cluster/isMaster[0]", "properties": { "___proto__": [ "es5:Boolean/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/cluster.html#cluster.isMaster", "doc": "Flag to determine if the current process is a master process in a cluster. A\nprocess is a master if process.env.NODE_WORKER_ID is undefined.
Flag to determine if the current process is a worker process in a cluster. A\nprocess is a worker if process.env.NODE_WORKER_ID is defined.
All settings set by the setupMaster are stored in this\nsettings object. This object is not supposed to be change or set manually by\nyou.
setupMaster is used to change the default 'fork' behavior. It takes one\noption object argument.\n
In the cluster, all living worker objects are stored in this object by their\nuniqueID as the key. This makes it easy to loop through all living workers,\nlike this:\n
A single instance of Node runs in a single thread. To take advantage of\nmulti-core systems the user will sometimes want to launch a cluster of Node\nprocesses to handle the load.\n
\n" }, "nodejs_latest:crypto/cipher": { "guid": "nodejs_latest:crypto/cipher", "properties": { "_prototype": [ { "guid": "nodejs_latest:crypto/cipher/prototype", "properties": {} } ], "_final": [ { "guid": "nodejs_latest:crypto/cipher/final[0]", "properties": { "_return": [ "es5:String/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/crypto.html#crypto.cipher.final", "doc": "Returns any remaining enciphered contents. output_encoding can be 'binary',\n'base64', or 'hex'.\n
You can disable automatic padding of the input data to block size.\n
\n", "fargs": [ { "id": "auto_padding", "type": [ "es5:Object/prototype" ] } ] } ], "_update": [ { "guid": "nodejs_latest:crypto/cipher/update[0]", "properties": { "_return": [ "nodejs_latest:crypto/cipher/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/crypto.html#crypto.cipher.update", "doc": "Updates the cipher with data. This returns the enciphered contents, and can be\ncalled many times with new data as it is streamed.
A class for encrypting data. It's a representation of the OpenSSL\nimplementation of cipher. It can\nbe created as a returned value from crypto.createCipher() or crypto.createCipheriv().\n
Returns any remaining plaintext which is deciphered.\n
\n", "fargs": [ { "id": "output_encoding", "type": [ "es5:Object/prototype" ], "opt": true } ] } ], "_setAutoPadding": [ { "guid": "nodejs_latest:crypto/decipher/setAutoPadding[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/crypto.html#crypto.decipher.setAutoPadding", "doc": "You can disable auto padding if the data has been encrypted without standard\nblock padding to prevent\ndecipher.final from checking and removing it. Can only work if the input\ndata's length is a multiple of the\nciphers block size. You must call this before streaming data to\ndecipher.update.
Updates the decipher with data.\n
A class for decrypting data. It's used to decipher previously created\ncipher objects. It can be created as a returned value from\ncrypto.createDeipher() or crypto.createDecipheriv().\n
Computes the shared secret and returns the computed shared secret.
\n", "fargs": [ { "id": "other_public_key", "type": [ "es5:Object/prototype" ] }, { "id": "input_encoding", "type": [ "es5:Object/prototype" ], "opt": true }, { "id": "output_encoding", "type": [ "es5:Object/prototype" ], "opt": true } ] } ], "_generateKeys": [ { "guid": "nodejs_latest:crypto/diffieHellman/generateKeys[0]", "properties": { "_return": [ "es5:String/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/crypto.html#crypto.diffieHellman.generateKeys", "doc": "Generates private and public Diffie-Hellman key values, and returns the public\nkey in the specified encoding. This key should be transferred to the other\nparty.
\n", "fargs": [ { "id": "encoding", "type": [ "es5:Object/prototype" ], "opt": true } ] } ], "_getGenerator": [ { "guid": "nodejs_latest:crypto/diffieHellman/getGenerator[0]", "properties": { "_return": [ "es5:String/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/crypto.html#crypto.diffieHellman.getGenerator", "doc": "Returns the Diffie-Hellman prime in the specified encoding.\n
\n", "fargs": [ { "id": "encoding", "type": [ "es5:Object/prototype" ], "opt": true } ] } ], "_getPrime": [ { "guid": "nodejs_latest:crypto/diffieHellman/getPrime[0]", "properties": { "_return": [ "es5:String/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/crypto.html#crypto.diffieHellman.getPrime", "doc": "Returns the Diffie-Hellman prime in the specified encoding.\n
\n", "fargs": [ { "id": "encoding", "type": [ "es5:Object/prototype" ], "opt": true } ] } ], "_getPrivateKey": [ { "guid": "nodejs_latest:crypto/diffieHellman/getPrivateKey[0]", "properties": { "_return": [ "es5:String/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/crypto.html#crypto.diffieHellman.getPrivateKey", "doc": "Returns the Diffie-Hellman private key in the specified encoding.
\n", "fargs": [ { "id": "encoding", "type": [ "es5:Object/prototype" ], "opt": true } ] } ], "_getPublicKey": [ { "guid": "nodejs_latest:crypto/diffieHellman/getPublicKey[0]", "properties": { "_return": [ "es5:String/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/crypto.html#crypto.diffieHellman.getPublicKey", "doc": "Returns the Diffie-Hellman public key in the specified encoding.
\n", "fargs": [ { "id": "encoding", "type": [ "es5:Object/prototype" ], "opt": true } ] } ], "_setPrivateKey": [ { "guid": "nodejs_latest:crypto/diffieHellman/setPrivateKey[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/crypto.html#crypto.diffieHellman.setPrivateKey", "doc": "Sets the Diffie-Hellman private key.
\n", "fargs": [ { "id": "public_key", "type": [ "es5:Object/prototype" ] }, { "id": "encoding", "type": [ "es5:Object/prototype" ], "opt": true } ] } ], "_setPublicKey": [ { "guid": "nodejs_latest:crypto/diffieHellman/setPublicKey[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/crypto.html#crypto.diffieHellman.setPublicKey", "doc": "Sets the Diffie-Hellman public key.
\n", "fargs": [ { "id": "public_key", "type": [ "es5:Object/prototype" ] }, { "id": "encoding", "type": [ "es5:Object/prototype" ], "opt": true } ] } ] }, "kind": "hidden", "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/crypto.html#crypto.diffieHellman", "doc": "This is a class for creating Diffie-Hellman key exchanges. It's a representation\nof the OpenSSL implementation of\ndiffie-Hellman. It can be created\nas a returned value from crypto.createDiffieHellman().\n
Calculates the digest of all of the passed data to be hashed.\n
\n", "fargs": [ { "id": "encoding", "type": [ "es5:Object/prototype" ], "opt": true } ] } ], "_update": [ { "guid": "nodejs_latest:crypto/hash/update[0]", "properties": { "_return": [ "es5:String/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/crypto.html#crypto.hash.update", "doc": "Updates the hash content with the given data. This can be called many times\nwith new data as it is streamed.
The class for creating hash digests of data. It's class a representation of the\nOpenSSL implementation of\nhash\nalgorithms. It can be created as a returned value from crypto.createHash().\n
Calculates the digest of all of the passed data to the hmac.\n
\n", "fargs": [ { "id": "encoding", "type": [ "es5:Object/prototype" ], "opt": true } ] } ], "_update": [ { "guid": "nodejs_latest:crypto/hmac/update[0]", "properties": { "_return": [ "nodejs_latest:crypto/hmac/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/crypto.html#crypto.hmac.update", "doc": "Update the HMAC content with the given data. This can be called many times\nwith new data as it is streamed.
A class for creating cryptographic hmac content. It's a representation of the\nOpenSSL implementation of hmac\nalgorithms. It can be created as a returned value from crypto.createHmac().\n
Calculates the signature on all the updated data passed through the signer.\n
\n", "fargs": [ { "id": "private_key", "type": [ "es5:Object/prototype" ] }, { "id": "output_format", "type": [ "es5:Object/prototype" ], "opt": true } ] } ], "_update": [ { "guid": "nodejs_latest:crypto/signer/update[0]", "properties": { "_return": [ "nodejs_latest:crypto/signer/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/crypto.html#crypto.signer.update", "doc": "Updates the signer object with data. This can be called many times with new data\nas it is streamed.
\n", "fargs": [ { "id": "data", "type": [ "es5:Object/prototype" ] } ] } ] }, "kind": "hidden", "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/crypto.html#crypto.signer", "doc": "This class is used to generate certificates for OpenSSL. It can be created as a\nreturned value from crypto.createSign().\n
Updates the verifier object with data. This can be called many times with new\ndata as it is streamed.
\n", "fargs": [ { "id": "data", "type": [ "es5:Object/prototype" ] } ] } ], "_verify": [ { "guid": "nodejs_latest:crypto/verifier/verify[0]", "properties": { "_return": [ "es5:Boolean/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/crypto.html#crypto.verifier.verify", "doc": "Returns true or false depending on the validity of the signature for the\ndata and public key.\n
This class is used to verify signed certificates for OpenSSL. It can be created\nas a returned value from crypto.createVerify().\n
Tells the kernel to join a multicast group with the IP_ADD_MEMBERSHIP socket\noption.\n
Returns an object containing the address information for a socket. For UDP\nsockets, this object contains the properties address and port.
For UDP sockets, listen for datagrams on a named port and optional address.\nIf address isn't specified, the OS tries to listen on all addresses.\n
Close the underlying socket and stop listening for data on it.
\n", "fargs": [] } ], "_createSocket": [ { "guid": "nodejs_latest:dgram/createSocket[0]", "properties": { "_return": [ "nodejs_latest:dgram/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/dgram.html#dgram.createSocket", "doc": "Creates a datagram socket of the specified types.\n
\n", "fargs": [ { "id": "type", "type": [ "es5:Object/prototype" ] }, { "id": "callback", "type": [ "es5:Object/prototype" ], "opt": true, "fargs": [] } ] } ], "_dropMembership": [ { "guid": "nodejs_latest:dgram/dropMembership[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/dgram.html#dgram.dropMembership", "doc": "The opposite of addMembership—this tells the kernel to leave a multicast group\nwith IP_DROP_MEMBERSHIP socket option. This is automatically called by the\nkernel when the socket is closed or process terminates, so most apps will never\nneed to call this.\n
Sends some information to a specified address:port. For UDP sockets, the\ndestination port and IP address must be specified.\n
Sets or clears the SO_BROADCAST socket option. When this option is set to\ntrue, UDP packets may be sent to a local interface's broadcast address.
Sets or clears the IP_MULTICAST_LOOP socket option. When this option is\ntrue, multicast packets will also be received on the local interface.
Sets the IP_MULTICAST_TTL socket option. TTL stands for "Time to Live," but\nin this context it specifies the number of IP hops that a packet is allowed to\ngo through, specifically for multicast traffic. Each router or gateway that\nforwards a packet decrements the TTL. If the TTL is decremented to 0 by a\nrouter, it will not be forwarded.\n
Sets the IP_TTL socket option. TTL stands for "Time to Live," but in this\ncontext it specifies the number of IP hops that a packet is allowed to go\nthrough. Each router or gateway that forwards a packet decrements the TTL. If\nthe TTL is decremented to 0 by a router, it will not be forwarded. Changing TTL\nvalues is typically done for network probes or when multicasting.\n
A datagram socket is a type of connectionless Internet socket, for the sending\nor receiving point for packet delivery services. Datagram sockets are available\nin Node.js by adding require('dgram') to your code.\n
Resolves a domain (e.g. 'google.com') into the first found A (IPv4) or AAAA\n(IPv6) record.\n
Resolves a domain (e.g. 'google.com') into an array of the record types\nspecified by rrtype. Valid rrtypes are:\n
The same as dns.resolve(), but only for IPv4 queries (A\nrecords).
The same as dns.resolve4() except for IPv6 queries (an AAAA\nquery).
The same as dns.resolve(), but only for canonical name records\n(CNAME records).\n
The same as dns.resolve(), but only for mail exchange queries\n(MX records).
The same as dns.resolve(), but only for name server records\n(NS records).
The same as dns.resolve(), but only for service records (SRV\nrecords).
The same as dns.resolve(), but only for text queries (TXT\nrecords).
Reverse resolves an IP address to an array of domain names.
\n", "fargs": [ { "id": "ip", "type": [ "es5:Object/prototype" ] }, { "id": "callback", "type": [ "es5:Object/prototype" ], "fargs": [ { "id": "err", "type": [ "es5:Error/prototype" ] }, { "id": "domains", "type": [ "es5:Array/prototype" ] } ] } ] } ] }, "kind": "package", "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/dns.html#dns", "doc": "DNS is the backbone of all operations on the Internet. To access this module,\ninclude require('dns') in your code.\n
Adds a listener to the end of the listeners array for the specified event.\n
\n", "fargs": [ { "id": "event", "type": [ "es5:Object/prototype" ] }, { "id": "callback", "type": [ "es5:Object/prototype" ], "fargs": [] } ] } ], "_emit": [ { "guid": "nodejs_latest:eventemitter/emit[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/events.html#eventemitter.emit", "doc": "Execute each of the subscribed listeners in order with the supplied arguments.
\n", "fargs": [ { "id": "event", "type": [ "es5:Object/prototype" ] }, { "id": "arg", "type": [ "es5:Object/prototype" ], "opt": true } ] } ], "_listeners": [ { "guid": "nodejs_latest:eventemitter/listeners[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/events.html#eventemitter.listeners", "doc": "Returns an array of listeners for the specified event. This array can be\nmanipulated, e.g. to remove listeners.\n
\n", "fargs": [ { "id": "event", "type": [ "es5:Object/prototype" ] } ] } ], "_once": [ { "guid": "nodejs_latest:eventemitter/once[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/events.html#eventemitter.once", "doc": "Adds a one time listener for the event. This listener is invoked only the\nnext time the event is fired, after which it is removed.\n
\n", "fargs": [ { "id": "event", "type": [ "es5:Object/prototype" ] }, { "id": "listener", "type": [ "es5:Object/prototype" ] } ] } ], "_removeAllListeners": [ { "guid": "nodejs_latest:eventemitter/removeAllListeners[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/events.html#eventemitter.removeAllListeners", "doc": "Removes all listeners, or those of the specified event.
\n", "fargs": [ { "id": "event", "type": [ "es5:Object/prototype" ], "opt": true } ] } ], "_removeListener": [ { "guid": "nodejs_latest:eventemitter/removeListener[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/events.html#eventemitter.removeListener", "doc": "Remove a listener from the listener array for the specified event.\n
\n", "fargs": [ { "id": "event", "type": [ "es5:Object/prototype" ] }, { "id": "listener", "type": [ "es5:Object/prototype" ] } ] } ], "_setMaxListeners": [ { "guid": "nodejs_latest:eventemitter/setMaxListeners[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/events.html#eventemitter.setMaxListeners", "doc": "By default, EventEmitters print a warning if more than 10 listeners are added\nfor a particular event. This is a useful default which helps finding memory\nleaks.\n
\n", "fargs": [ { "id": "n", "type": [ "es5:Object/prototype" ] } ] } ] }, "kind": "hidden", "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/events.html#eventemitter", "doc": "Many objects in Node.js emit events. Some examples include:\n
\n" }, "nodejs_latest:fs": { "guid": "nodejs_latest:fs", "properties": { "_prototype": [ { "guid": "nodejs_latest:fs/prototype", "properties": {} } ], "_chmod": [ { "guid": "nodejs_latest:fs/chmod[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/fs.html#fs.chmod", "doc": "An asynchronous\nchmod(2).\nThis changes the permissions of the file specified whose, which is dereferenced\nif it is a symbolic link.
\n", "fargs": [ { "id": "path", "type": [ "es5:Object/prototype" ] }, { "id": "mode", "type": [ "es5:Object/prototype" ] }, { "id": "callback", "type": [ "es5:Object/prototype" ], "opt": true, "fargs": [ { "id": "err", "type": [ "es5:Error/prototype" ] } ] } ] } ], "_chmodSync": [ { "guid": "nodejs_latest:fs/chmodSync[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/fs.html#fs.chmodSync", "doc": "A synchronous\nchmod(2).\nThis changes the permissions of the file specified whose, which is dereferenced\nif it is a symbolic link.
\n", "fargs": [ { "id": "path", "type": [ "es5:Object/prototype" ] }, { "id": "mode", "type": [ "es5:Object/prototype" ] } ] } ], "_chown": [ { "guid": "nodejs_latest:fs/chown[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/fs.html#fs.chown", "doc": "An asynchronous\nchown(2).\nThis changes the ownership of the file specified by path, which is\nde-referenced if it is a symbolic link.
A synchronous\nchown(2).\nThis changes the ownership of the file specified by path, which is\ndereferenced if it is a symbolic link
An asynchronous file close; for more information, see\nclose(2).
\n", "fargs": [ { "id": "fd", "type": [ "es5:Object/prototype" ] }, { "id": "callback", "type": [ "es5:Object/prototype" ], "opt": true, "fargs": [ { "id": "err", "type": [ "es5:Error/prototype" ] } ] } ] } ], "_closeSync": [ { "guid": "nodejs_latest:fs/closeSync[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/fs.html#fs.closeSync", "doc": "A synchronous file close; for more information, see\nclose(2).
\n", "fargs": [ { "id": "fd", "type": [ "es5:Object/prototype" ] } ] } ], "_createReadStream": [ { "guid": "nodejs_latest:fs/createReadStream[0]", "properties": { "_return": [ "nodejs_latest:fs/ReadStream/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/fs.html#fs.createReadStream", "doc": "Returns a new fs.ReadStream object.\n
Returns a new WriteStream object.\n
\n", "fargs": [ { "id": "path", "type": [ "es5:Object/prototype" ] }, { "id": "options", "type": [ "es5:Object/prototype" ], "opt": true } ] } ], "_fchmod": [ { "guid": "nodejs_latest:fs/fchmod[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/fs.html#fs.fchmod", "doc": "An asynchronous\nfchmod(2)\n. This changes the permissions of the file referred to by the open file\ndescriptor.
\n", "fargs": [ { "id": "fd", "type": [ "es5:Object/prototype" ] }, { "id": "mode", "type": [ "es5:Object/prototype" ] }, { "id": "callback", "type": [ "es5:Object/prototype" ], "opt": true, "fargs": [ { "id": "err", "type": [ "es5:Error/prototype" ] } ] } ] } ], "_fchmodSync": [ { "guid": "nodejs_latest:fs/fchmodSync[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/fs.html#fs.fchmodSync", "doc": "A synchronous\nfchmod(2)\n. This changes the permissions of the file referred to by the open file\ndescriptor.
\n", "fargs": [ { "id": "fd", "type": [ "es5:Object/prototype" ] }, { "id": "mode", "type": [ "es5:Object/prototype" ] } ] } ], "_fchown": [ { "guid": "nodejs_latest:fs/fchown[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/fs.html#fs.fchown", "doc": "An asynchronous\nfchown(2)\n. This changes the ownership of the file referred to by the open file descriptor\nfd.
\n", "fargs": [ { "id": "fd", "type": [ "es5:Object/prototype" ] }, { "id": "uid", "type": [ "es5:Object/prototype" ] }, { "id": "gid", "type": [ "es5:Object/prototype" ] }, { "id": "callback", "type": [ "es5:Object/prototype" ], "opt": true, "fargs": [ { "id": "err", "type": [ "es5:Error/prototype" ] } ] } ] } ], "_fchownSync": [ { "guid": "nodejs_latest:fs/fchownSync[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/fs.html#fs.fchownSync", "doc": "A synchronous\nfchown(2)\n. This changes the ownership of the file referred to by the open file descriptor\nfd.
\n", "fargs": [ { "id": "fd", "type": [ "es5:Object/prototype" ] }, { "id": "uid", "type": [ "es5:Object/prototype" ] }, { "id": "gid", "type": [ "es5:Object/prototype" ] } ] } ], "_fstat": [ { "guid": "nodejs_latest:fs/fstat[0]", "properties": { "_return": [ "nodejs_latest:fs/Stats/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/fs.html#fs.fstat", "doc": "An asynchronous\nfstat(2).
\n", "fargs": [ { "id": "fd", "type": [ "es5:Object/prototype" ] }, { "id": "callback", "type": [ "es5:Object/prototype" ], "opt": true, "fargs": [ { "id": "err", "type": [ "es5:Error/prototype" ] }, { "id": "stats", "type": [ [ "nodejs_latest:fs/Stats/prototype" ] ] } ] } ] } ], "_fstatSync": [ { "guid": "nodejs_latest:fs/fstatSync[0]", "properties": { "_return": [ "nodejs_latest:fs/Stats/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/fs.html#fs.fstatSync", "doc": "A synchronous\nfstat(2).
\n", "fargs": [ { "id": "fd", "type": [ "es5:Object/prototype" ] } ] } ], "_fsync": [ { "guid": "nodejs_latest:fs/fsync[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/fs.html#fs.fsync", "doc": "An asynchronous\nfsync(2).
\n", "fargs": [ { "id": "fd", "type": [ "es5:Object/prototype" ] }, { "id": "callback", "type": [ "es5:Object/prototype" ], "opt": true, "fargs": [ { "id": "err", "type": [ "es5:Object/prototype" ] } ] } ] } ], "_fsyncSync": [ { "guid": "nodejs_latest:fs/fsyncSync[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/fs.html#fs.fsyncSync", "doc": "A synchronous\nfsync(2).
\n", "fargs": [ { "id": "fd", "type": [ "es5:Object/prototype" ] } ] } ], "_futimes": [ { "guid": "nodejs_latest:fs/futimes[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/fs.html#fs.futimes", "doc": "An asynchronous\nfutimes(3). Change the file timestamps of a file referenced by the supplied file\ndescriptor.
\n", "fargs": [ { "id": "fd", "type": [ "es5:Object/prototype" ] }, { "id": "atime", "type": [ "es5:Object/prototype" ] }, { "id": "mtime", "type": [ "es5:Object/prototype" ] }, { "id": "callback", "type": [ "es5:Object/prototype" ], "opt": true, "fargs": [] } ] } ], "_futimesSync": [ { "guid": "nodejs_latest:fs/futimesSync[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/fs.html#fs.futimesSync", "doc": "A synchronous\nfutimes(3). Change the file timestamps of a file referenced by the supplied file\ndescriptor.
\n", "fargs": [ { "id": "fd", "type": [ "es5:Object/prototype" ] }, { "id": "atime", "type": [ "es5:Object/prototype" ] }, { "id": "mtime", "type": [ "es5:Object/prototype" ] } ] } ], "_lchmod": [ { "guid": "nodejs_latest:fs/lchmod[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/fs.html#fs.lchmod", "doc": "An asynchronous lchmod(2).\nThis is like chmod() except in the case where the named file is a\nsymbolic link, in which case lchmod() sets the permission bits of the link,\nwhile chmod() sets the bits of the file the link references.
A synchronous lchmod(2). This\nis like chmodSync()except in the case where the named file is\na symbolic link, in which case lchmod() sets the permission bits of the link,\nwhile chmod() sets the bits of the file the link references.
An asynchronous\nlchown(2)\n. This is like chown(), but doesn't dereference symbolic links.
Synchronous\nlchown(2)\n. This is like chownSync(), but doesn't dereference symbolic\nlinks
An asynchronous\nlink(2).
\n", "fargs": [ { "id": "srcpath", "type": [ "es5:Object/prototype" ] }, { "id": "dstpath", "type": [ "es5:Object/prototype" ] }, { "id": "callback", "type": [ "es5:Object/prototype" ], "opt": true, "fargs": [ { "id": "err", "type": [ "es5:Error/prototype" ] } ] } ] } ], "_linkSync": [ { "guid": "nodejs_latest:fs/linkSync[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/fs.html#fs.linkSync", "doc": "A synchronous\nlink(2).
\n", "fargs": [ { "id": "srcpath", "type": [ "es5:Object/prototype" ] }, { "id": "dstpath", "type": [ "es5:Object/prototype" ] } ] } ], "_lstat": [ { "guid": "nodejs_latest:fs/lstat[0]", "properties": { "_return": [ "nodejs_latest:fs/Stats/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/fs.html#fs.lstat", "doc": "An asynchronous\nlstat(2).
\n", "fargs": [ { "id": "path", "type": [ "es5:Object/prototype" ] }, { "id": "callback", "type": [ "es5:Object/prototype" ], "opt": true, "fargs": [ { "id": "err", "type": [ "es5:Error/prototype" ] }, { "id": "stats", "type": [ [ "nodejs_latest:fs/Stats/prototype" ] ] } ] } ] } ], "_lstatSync": [ { "guid": "nodejs_latest:fs/lstatSync[0]", "properties": { "_return": [ "nodejs_latest:fs/Stats/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/fs.html#fs.lstatSync", "doc": "A synchronous\nlstat(2).
\n", "fargs": [ { "id": "path", "type": [ "es5:Object/prototype" ] } ] } ], "_mkdir": [ { "guid": "nodejs_latest:fs/mkdir[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/fs.html#fs.mkdir", "doc": "An asynchronous\nmkdir(2).
\n", "fargs": [ { "id": "path", "type": [ "es5:Object/prototype" ] }, { "id": "mode", "type": [ "es5:Object/prototype" ], "opt": true }, { "id": "callback", "type": [ "es5:Object/prototype" ], "opt": true, "fargs": [ { "id": "err", "type": [ "es5:Error/prototype" ] } ] } ] } ], "_mkdirSync": [ { "guid": "nodejs_latest:fs/mkdirSync[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/fs.html#fs.mkdirSync", "doc": "A synchronous\nmkdir(2).
\n", "fargs": [ { "id": "path", "type": [ "es5:Object/prototype" ] }, { "id": "mode", "type": [ "es5:Object/prototype" ], "opt": true } ] } ], "_open": [ { "guid": "nodejs_latest:fs/open[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/fs.html#fs.open", "doc": "An asynchronous file open; for more information, see\nopen(2).\n
\n", "fargs": [ { "id": "path", "type": [ "es5:Object/prototype" ] }, { "id": "flags", "type": [ "es5:Object/prototype" ] }, { "id": "mode", "type": [ "es5:Object/prototype" ], "opt": true }, { "id": "callback", "type": [ "es5:Object/prototype" ], "opt": true, "fargs": [ { "id": "err", "type": [ "es5:Error/prototype" ] }, { "id": "fd", "type": [ "es5:Number/prototype" ] } ] } ] } ], "_openSync": [ { "guid": "nodejs_latest:fs/openSync[0]", "properties": { "_return": [ "es5:Number/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/fs.html#fs.openSync", "doc": "A synchronous file open; for more information, see\nopen(2).\n
\n", "fargs": [ { "id": "path", "type": [ "es5:Object/prototype" ] }, { "id": "flags", "type": [ "es5:Object/prototype" ] }, { "id": "mode", "type": [ "es5:Object/prototype" ], "opt": true } ] } ], "_read": [ { "guid": "nodejs_latest:fs/read[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/fs.html#fs.read", "doc": "Read data from the file specified by fd and writes it to buffer. If\nposition is null, data will be read from the current file position.
An asynchronous\nreaddir(3). It reads the contents of a directory.
\n", "fargs": [ { "id": "path", "type": [ "es5:Object/prototype" ] }, { "id": "callback", "type": [ "es5:Object/prototype" ], "opt": true, "fargs": [ { "id": "err", "type": [ "es5:Error/prototype" ] }, { "id": "files", "type": [ "es5:Array/prototype" ] } ] } ] } ], "_readdirSync": [ { "guid": "nodejs_latest:fs/readdirSync[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/fs.html#fs.readdirSync", "doc": "A synchronous\nreaddir(3). Returns an array of filenames, excluding '.' and '..'.
Asynchronously reads the entire contents of a file. If no encoding is specified,\nthen the raw buffer is returned.\n
\n", "fargs": [ { "id": "filename", "type": [ "es5:Object/prototype" ] }, { "id": "encoding", "type": [ "es5:Object/prototype" ], "opt": true }, { "id": "callback", "type": [ "es5:Object/prototype" ], "opt": true, "fargs": [ { "id": "err", "type": [ "es5:Error/prototype" ] }, { "id": "data", "type": [ [ "nodejs_latest:Buffer/prototype" ] ] } ] } ] } ], "_readFileSync": [ { "guid": "nodejs_latest:fs/readFileSync[0]", "properties": { "_return": [ "es5:String/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/fs.html#fs.readFileSync", "doc": "Synchronous version of fs.readFile(). Returns the contents of\nthe filename.\n
An asynchronous\nreadlink(2).
\n", "fargs": [ { "id": "path", "type": [ "es5:Object/prototype" ] }, { "id": "callback", "type": [ "es5:Object/prototype" ], "opt": true, "fargs": [ { "id": "err", "type": [ "es5:Error/prototype" ] }, { "id": "linkString", "type": [ "es5:String/prototype" ] } ] } ] } ], "_readlinkSync": [ { "guid": "nodejs_latest:fs/readlinkSync[0]", "properties": { "_return": [ "es5:String/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/fs.html#fs.readlinkSync", "doc": "A synchronous\nreadlink(2).\n
\n", "fargs": [ { "id": "path", "type": [ "es5:Object/prototype" ] } ] } ], "_readSync": [ { "guid": "nodejs_latest:fs/readSync[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/fs.html#fs.readSync", "doc": "The synchronous version of buffer-based fs.read(). Reads data from\nthe file specified by fd and writes it to buffer. If position is null,\ndata will be read from the current file position.\n
An asynchronous\nrealpath(3). You can use process.cwd() to resolve relative paths.
A synchronous\nrealpath(3).\n
\n", "fargs": [ { "id": "path", "type": [ "es5:Object/prototype" ] } ] } ], "_rename": [ { "guid": "nodejs_latest:fs/rename[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/fs.html#fs.rename", "doc": "An asynchronous\nrename(2)\noperation. Turns path1 into path2.
A synchronous\nrename(2)\noperation. Turns path1 into path2.
An asynchronous\nrmdir(2).
\n", "fargs": [ { "id": "path", "type": [ "es5:Object/prototype" ] }, { "id": "callback", "type": [ "es5:Object/prototype" ], "opt": true, "fargs": [ { "id": "err", "type": [ "es5:Error/prototype" ] } ] } ] } ], "_rmdirSync": [ { "guid": "nodejs_latest:fs/rmdirSync[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/fs.html#fs.rmdirSync", "doc": "A synchronous\nrmdir(2).
\n", "fargs": [ { "id": "path", "type": [ "es5:Object/prototype" ] } ] } ], "_stat": [ { "guid": "nodejs_latest:fs/stat[0]", "properties": { "_return": [ "nodejs_latest:fs/Stats/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/fs.html#fs.stat", "doc": "An asynchronous\nstat(2).
\n", "fargs": [ { "id": "path", "type": [ "es5:Object/prototype" ] }, { "id": "callback", "type": [ "es5:Object/prototype" ], "opt": true, "fargs": [ { "id": "err", "type": [ "es5:Error/prototype" ] }, { "id": "stats", "type": [ [ "nodejs_latest:fs/Stats/prototype" ] ] } ] } ] } ], "_statSync": [ { "guid": "nodejs_latest:fs/statSync[0]", "properties": { "_return": [ "nodejs_latest:fs/Stats/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/fs.html#fs.statSync", "doc": "A synchronous\nstat(2).
\n", "fargs": [ { "id": "path", "type": [ "es5:Object/prototype" ] } ] } ], "_symlink": [ { "guid": "nodejs_latest:fs/symlink[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/fs.html#fs.symlink", "doc": "An asynchronous\nsymlink(2).
\n", "fargs": [ { "id": "linkdata", "type": [ "es5:Object/prototype" ] }, { "id": "path", "type": [ "es5:Object/prototype" ] }, { "id": "type", "type": [ "es5:Object/prototype" ], "opt": true }, { "id": "callback", "type": [ "es5:Object/prototype" ], "opt": true, "fargs": [ { "id": "err", "type": [ "es5:Error/prototype" ] } ] } ] } ], "_symlinkSync": [ { "guid": "nodejs_latest:fs/symlinkSync[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/fs.html#fs.symlinkSync", "doc": "A synchronous\nsymlink(2).
\n", "fargs": [ { "id": "linkdata", "type": [ "es5:Object/prototype" ] }, { "id": "path", "type": [ "es5:Object/prototype" ] }, { "id": "type", "type": [ "es5:Object/prototype" ], "opt": true } ] } ], "_truncate": [ { "guid": "nodejs_latest:fs/truncate[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/fs.html#fs.truncate", "doc": "An asynchronous\nftruncate(2). It truncates a file to the specified length.
\n", "fargs": [ { "id": "fd", "type": [ "es5:Object/prototype" ] }, { "id": "len", "type": [ "es5:Object/prototype" ] }, { "id": "callback", "type": [ "es5:Object/prototype" ], "opt": true, "fargs": [ { "id": "err", "type": [ "es5:Error/prototype" ] } ] } ] } ], "_truncateSync": [ { "guid": "nodejs_latest:fs/truncateSync[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/fs.html#fs.truncateSync", "doc": "A synchronous\nftruncate(2). It truncates a file to the specified length.
\n", "fargs": [ { "id": "fd", "type": [ "es5:Object/prototype" ] }, { "id": "len", "type": [ "es5:Object/prototype" ] } ] } ], "_unlink": [ { "guid": "nodejs_latest:fs/unlink[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/fs.html#fs.unlink", "doc": "An asynchronous\nunlink(2)\n.
\n", "fargs": [ { "id": "path", "type": [ "es5:Object/prototype" ] }, { "id": "callback", "type": [ "es5:Object/prototype" ], "opt": true, "fargs": [ { "id": "err", "type": [ "es5:Error/prototype" ] } ] } ] } ], "_unlinkSync": [ { "guid": "nodejs_latest:fs/unlinkSync[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/fs.html#fs.unlinkSync", "doc": "A synchronous\nunlink(2)\n.
\n", "fargs": [ { "id": "path", "type": [ "es5:Object/prototype" ] } ] } ], "_unwatchFile": [ { "guid": "nodejs_latest:fs/unwatchFile[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/fs.html#fs.unwatchFile", "doc": "Stops watching for changes on filename.\n
An asynchronous\nutime(2).\nChanges the timestamps of the file referenced by the supplied path.
\n", "fargs": [ { "id": "path", "type": [ "es5:Object/prototype" ] }, { "id": "atime", "type": [ "es5:Object/prototype" ] }, { "id": "mtime", "type": [ "es5:Object/prototype" ] }, { "id": "callback", "type": [ "es5:Object/prototype" ], "opt": true, "fargs": [] } ] } ], "_utimesSync": [ { "guid": "nodejs_latest:fs/utimesSync[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/fs.html#fs.utimesSync", "doc": "A synchronous\nutime(2).\nChange the timestamps of the file referenced by the supplied path.
\n", "fargs": [ { "id": "path", "type": [ "es5:Object/prototype" ] }, { "id": "atime", "type": [ "es5:Object/prototype" ] }, { "id": "mtime", "type": [ "es5:Object/prototype" ] } ] } ], "_watch": [ { "guid": "nodejs_latest:fs/watch[0]", "properties": { "_return": [ "nodejs_latest:fs/FSWatcher/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/fs.html#fs.watch", "doc": "Watch for changes on filename.\n
Watches for changes on filename.\n
Writes buffer to the file specified by fd. Note that it's unsafe to use\nfs.write multiple times on the same file without waiting for the callback. For\nthis scenario, fs.createWriteStream() is strongly\nrecommended.\n
Asynchronously writes data to a file, replacing the file if it already exists.\n
\n", "fargs": [ { "id": "filename", "type": [ "es5:Object/prototype" ] }, { "id": "data", "type": [ "es5:Object/prototype" ] }, { "id": "encoding", "type": [ "es5:Object/prototype" ], "opt": true }, { "id": "callback", "type": [ "es5:Object/prototype" ], "opt": true, "fargs": [] } ] } ], "_writeFileSync": [ { "guid": "nodejs_latest:fs/writeFileSync[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/fs.html#fs.writeFileSync", "doc": "The synchronous version of fs.writeFile().
A synchronous version of the buffer-based fs.write().\n
In Node.js, file input and output is provided by simple wrappers around standard\nPOSIX functions. All the read and write\nmethods methods have asynchronous and synchronous forms. To use this module,\ninclude require('fs') in your code.\n
Stop watching for changes on the given FSWatcher.
Objects returned from fs.watch() are of this type. You can\nmonitor any changes that occur on a watched file by listening for the events in\nthis object.
This is a streams.ReadableStream, created from the\nfunction fs.createReadStream().
Indicates if the object is a block\ndevice.
\n", "fargs": [] } ], "_isCharacterDevice": [ { "guid": "nodejs_latest:fs/Stats/prototype/isCharacterDevice[0]", "properties": { "_return": [ "es5:Boolean/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/fs.html#fs.Stats.isCharacterDevice", "doc": "Indicates if the object is a character\ndevice.
\n", "fargs": [] } ], "_isDirectory": [ { "guid": "nodejs_latest:fs/Stats/prototype/isDirectory[0]", "properties": { "_return": [ "es5:Boolean/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/fs.html#fs.Stats.isDirectory", "doc": "Indicates if the object is a directory.
\n", "fargs": [] } ], "_isFIFO": [ { "guid": "nodejs_latest:fs/Stats/prototype/isFIFO[0]", "properties": { "_return": [ "es5:Boolean/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/fs.html#fs.Stats.isFIFO", "doc": "Indicates if the object is a named\npipe.
\n", "fargs": [] } ], "_isFile": [ { "guid": "nodejs_latest:fs/Stats/prototype/isFile[0]", "properties": { "_return": [ "es5:Boolean/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/fs.html#fs.Stats.isFile", "doc": "Indicates if the object is a file.
\n", "fargs": [] } ], "_isSocket": [ { "guid": "nodejs_latest:fs/Stats/prototype/isSocket[0]", "properties": { "_return": [ "es5:Boolean/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/fs.html#fs.Stats.isSocket", "doc": "Indicates if the object is a socket\nfile.
\n", "fargs": [] } ], "_isSymbolicLink": [ { "guid": "nodejs_latest:fs/Stats/prototype/isSymbolicLink[0]", "properties": { "_return": [ "es5:Boolean/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/fs.html#fs.Stats.isSymbolicLink", "doc": "Indicates if the object is a symbolic link; this is only valid with fs.lstat()\nand fs.lstatSynch().
Objects returned from fs.stat(), fs.lstat(), and\nfs.fstat() (and their synchronous counterparts) are of this type.\nThe object contains the following methods:\n
The number of bytes written so far. This doesn't include data that is still\nqueued for writing.
\n" } ] } } ] }, "kind": "hidden", "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/fs.html#fs.WriteStream", "doc": "This is a WriteStream, created from the function\nfs.createWriteStream().
This function is deprecated; please use\nhttp.request() instead.\n
\n", "fargs": [ { "id": "port", "type": [ "es5:Object/prototype" ], "opt": true }, { "id": "host", "type": [ "es5:Object/prototype" ], "opt": true } ] } ], "_createServer": [ { "guid": "nodejs_latest:http/createServer[0]", "properties": { "_return": [ "nodejs_latest:http/Server/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/http.html#http.createServer", "doc": "Returns a new web server object.
\n", "fargs": [ { "id": "requestListener", "opt": true, "suggest": [ { "name": "process.env.port", "replaceText": "process.env.port" } ], "fargs": [ { "id": "req", "type": [ "nodejs_latest:http/ServerRequest/prototype" ] }, { "id": "res", "type": [ "nodejs_latest:http/ServerResponse/prototype" ] } ], "type": [ "es5:Object/prototype" ] } ] } ], "_get": [ { "guid": "nodejs_latest:http/get[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/http.html#http.get", "doc": "Since most requests are GET requests without bodies, Node.js provides this\nconvenience method. The only difference between this method and http.request() is that it sets the method to GET and calls req.end()\nautomatically.\n
This is the global instance of http.Agent which is used as the\ndefault for all HTTP client requests.
Node.js maintains several connections per server to make HTTP requests. This\nfunction allows one to transparently issue requests.\n
\n", "fargs": [ { "id": "options", "type": [ "es5:Object/prototype" ] }, { "id": "callback", "type": [ "es5:Object/prototype" ], "fargs": [ { "id": "response", "type": [ [ "nodejs_latest:http/ClientRequest/prototype" ] ] } ] } ] } ] }, "kind": "package", "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/http.html#http", "doc": "The HTTP interfaces in Node.js are designed to support many features of the\nprotocol which have been traditionally difficult to use. In particular, large,\npossibly chunk-encoded, messages. The interface is careful to never buffer\nentire requests or responses—the user is always able to stream data. To use the\nHTTP server and client, add require('http') to your code.\n
Determines how many concurrent sockets the agent can have open per host. By\ndefault, this is set to 5.
\n" } ], "_sockets": [ { "guid": "nodejs_latest:http/Agent/prototype/sockets[0]", "properties": { "___proto__": [ "es5:Number/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/http.html#http.Agent.sockets", "doc": "An object which contains arrays of sockets currently in use by the Agent.\nDon't modify this!
\n" } ] } } ] }, "kind": "hidden", "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/http.html#http.Agent", "doc": "Starting with Node.js version 0.5.3, there's a new implementation of the HTTP\nAgent which is used for pooling sockets used in HTTP client requests.\n
\n" }, "nodejs_latest:http/ClientRequest": { "guid": "nodejs_latest:http/ClientRequest", "properties": { "_prototype": [ { "guid": "nodejs_latest:http/ClientRequest/prototype", "properties": { "_abort": [ { "guid": "nodejs_latest:http/ClientRequest/prototype/abort[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/http.html#http.ClientRequest.abort", "doc": "Aborts a request, since NOde.js version 0.3.8.
\n", "fargs": [] } ], "_end": [ { "guid": "nodejs_latest:http/ClientRequest/prototype/end[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/http.html#http.ClientRequest.end", "doc": "Finishes sending the request. If any parts of the body are unsent, it will flush\nthem to the stream. If the request is chunked, this will send the terminating\n'0\\r\\n\\r\\n'.\n
Once a socket is assigned to this request and is connected,\nnet.Socket.setNoDelay() is called.
Once a socket is assigned to this request and is connected,\nnet.Socket.setKeepAlive() is called.
Once a socket is assigned to this request and is connected,\nnet.Socket.setTimeout() is called.
Sends a chunk of the body. By calling this method many times, the user can\nstream a request body to a server—in that case, it's suggested you use the\n['Transfer-Encoding', 'chunked'] header line when creating the request.
This object is created internally and returned from http.request(). It represents an in-progress request whose header has\nalready been queued. The header is still mutable using the setHeader(name,\nvalue), getHeader(name), and removeHeader(name) methods. The actual header\nwill be sent along with the first data chunk or when closing the connection.\nThis is both a Writable Stream and an\nEventEmitter.\n
The response headers object.
\n" } ], "_httpVersion": [ { "guid": "nodejs_latest:http/ClientResponse/prototype/httpVersion[0]", "properties": { "___proto__": [ "es5:String/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/http.html#http.ClientResponse.httpVersion", "doc": "The HTTP version of the connected-to server. Usually either '1.1' or '1.0'.\nresponse.httpVersionMajor is the first integer and response.httpVersionMinor\nis the second.
Pauses the response from emitting events. Useful to throttle back a download.
\n", "fargs": [] } ], "_resume": [ { "guid": "nodejs_latest:http/ClientResponse/prototype/resume[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/http.html#http.ClientResponse.resume", "doc": "Resumes a paused response.
\n", "fargs": [] } ], "_setEncoding": [ { "guid": "nodejs_latest:http/ClientResponse/prototype/setEncoding[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/http.html#http.ClientResponse.setEncoding", "doc": "Set the encoding for the response body, either 'utf8', 'ascii', or\n'base64'.
The 3-digit HTTP response status code, like 200, 404, e.t.c.
The response trailers object. Only populated after the end event.
This object is created when making a request with http.request(). It is passed to the 'response' event of the request\nobject.\n
(related to: net.Server.close)\n
\n", "fargs": [] } ], "_listen": [ { "guid": "nodejs_latest:http/Server/prototype/listen[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/http.html#http.Server.listen", "doc": "Begin accepting connections on the specified port and hostname. If the hostname\nis omitted, the server accepts connections directed to any IPv4 address\n(INADDR_ANY). To listen to a Unix socket, supply a filename instead of port\nand hostname.\n
A representation of the server within the http module. To create an HTTP\nserver, you'll need to first call http.createServer(),\nwith something like this:\n
The net.Socket object associated with the connection.\n
Returns the request header.\n
\n" } ], "_httpVersion": [ { "guid": "nodejs_latest:http/ServerRequest/prototype/httpVersion[0]", "properties": { "___proto__": [ "es5:String/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/http.html#http.ServerRequest.httpVersion", "doc": "The HTTP protocol version as a string; for example: '1.1', '1.0'.\nrequest.httpVersionMajor is the first integer and request.httpVersionMinor\nis the second.
The request method as a string, like 'GET' or 'DELETE'.
Pauses request from emitting events. Useful to throttle back an upload.
\n", "fargs": [] } ], "_resume": [ { "guid": "nodejs_latest:http/ServerRequest/prototype/resume[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/http.html#http.ServerRequest.resume", "doc": "Resumes a paused request.
\n", "fargs": [] } ], "_setEncoding": [ { "guid": "nodejs_latest:http/ServerRequest/prototype/setEncoding[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/http.html#http.ServerRequest.setEncoding", "doc": "Set the encoding for the request body. Defaults to null, which means that the\n'data' event emits a Buffer object.
Contains the HTTP trailers (if present). Only populated after the 'end' event.\n
Request URL string. This contains only the URL that is present in the actual\nHTTP request. Fo example, if the request is:\n
\n" } ] } } ] }, "kind": "hidden", "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/http.html#http.ServerRequest", "doc": "This object is created internally by an HTTP server—not by the user—and passed\nas the first argument to a 'request' listener.\n
This method adds HTTP trailing headers (a header, but at the end of the message)\nto the response.\n
\n", "fargs": [ { "id": "headers", "type": [ "es5:Object/prototype" ] } ] } ], "_end": [ { "guid": "nodejs_latest:http/ServerResponse/prototype/end[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/http.html#http.ServerResponse.end", "doc": "This method signals to the server that all of the response headers and body has\nbeen sent; that server should consider this message complete. response.end()\nmust be called on each response.\n
Reads out a header that's already been queued but not sent to the client. Note\nthat the name is case-insensitive. This can only be called before headers get\nimplicitly flushed.\n
\n", "fargs": [ { "id": "name", "type": [ "es5:Object/prototype" ] } ] } ], "_removeHeader": [ { "guid": "nodejs_latest:http/ServerResponse/prototype/removeHeader[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/http.html#http.ServerResponse.removeHeader", "doc": "Removes a header that's queued for implicit sending.\n
\n", "fargs": [ { "id": "name", "type": [ "es5:Object/prototype" ] } ] } ], "_setHeader": [ { "guid": "nodejs_latest:http/ServerResponse/prototype/setHeader[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/http.html#http.ServerResponse.setHeader", "doc": "Sets a single header value for implicit headers. If this header already exists\nin the to-be-sent headers, its value is replaced. Use an array of strings here\nif you need to send multiple headers with the same name.\n
\n", "fargs": [ { "id": "name", "type": [ "es5:Object/prototype" ] }, { "id": "value", "type": [ "es5:Object/prototype" ] } ] } ], "_statusCode": [ { "guid": "nodejs_latest:http/ServerResponse/prototype/statusCode[0]", "properties": { "___proto__": [ "es5:Number/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/http.html#http.ServerResponse.statusCode", "doc": "When using implicit headers (not calling response.writeHead() explicitly),\nthis property controls the status code that will be send to the client when the\nheaders get flushed; for example: response.statusCode = 404;.\n
If this method is called and response.writeHead() has not been called, it'll\nswitch to implicit header mode and flush the implicit headers.\n
Sends an HTTP/1.1 100 Continue message to the client, indicating that the\nrequest body should be sent. For more information, see the\nhttp.Server@checkContinue event.
Sends a response header to the request.\n
\n", "fargs": [ { "id": "statusCode", "type": [ "es5:Object/prototype" ] }, { "id": "reasonPhrase", "type": [ "es5:Object/prototype" ], "opt": true }, { "id": "headers", "type": [ "es5:Object/prototype" ], "opt": true } ] } ] } } ] }, "kind": "hidden", "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/http.html#http.ServerResponse", "doc": "This object is created internally by a HTTP server—not by the user. It is passed\nas the second parameter to the 'request' event. It is a\nWritable Stream.
Returns a new HTTPS web server object.\n
\n", "fargs": [ { "id": "options", "type": [ "es5:Object/prototype" ] }, { "id": "callback", "type": [ "es5:Object/prototype" ], "opt": true, "fargs": [ { "id": "request", "type": [ [ "nodejs_latest:http/ClientResponse/prototype" ] ] }, { "id": "response", "type": [ "es5:Object/prototype" ] } ] } ] } ], "_get": [ { "guid": "nodejs_latest:https/get[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/https.html#https.get", "doc": "Exactly like http.get() but for HTTPS.\n
A global instance of the https.Agent, which is used as the\ndefault for all HTTPS client requests.
Makes a request to a secure web server.\n
\n", "fargs": [ { "id": "options", "type": [ "es5:Object/prototype" ] }, { "id": "callback", "type": [ "es5:Object/prototype" ], "fargs": [] } ] } ] }, "kind": "package", "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/https.html#https", "doc": "HTTPS is the HTTP protocol over TLS/SSL. In Node.js, this is implemented as a\nseparate module. To use this module, include require('https') in your code.\n
Determines how many concurrent sockets the agent can have open per host. By\ndefault, this is set to 5.
\n" } ], "_sockets": [ { "guid": "nodejs_latest:https/Agent/prototype/sockets[0]", "properties": { "___proto__": [ "es5:Object/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/https.html#https.Agent.sockets", "doc": "An object which contains arrays of sockets currently in use by the Agent.\nDon't modify this!
\n" } ] } } ] }, "kind": "hidden", "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/https.html#https.Agent", "doc": "An Agent object for HTTPS, similar to http.Agent. For more\ninformation, see https.request().
(related to: net.Server.close)\n
\n", "fargs": [] } ], "_listen": [ { "guid": "nodejs_latest:https/Server/prototype/listen[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/https.html#https.Server.listen", "doc": "Begin accepting connections on the specified port and hostname. If the hostname\nis omitted, the server accepts connections directed to any IPv4 address\n(INADDR_ANY). To listen to a Unix socket, supply a filename instead of port\nand hostname.\n
This class is a subclass of tls.Server and emits the same\nevents as http.Server.\n
The module objects required by this one.
\n" } ], "_filename": [ { "guid": "nodejs_latest:module/filename[0]", "properties": { "___proto__": [ "es5:String/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/modules.html#module.filename", "doc": "The fully resolved filename to the module.
\n" } ], "_id": [ { "guid": "nodejs_latest:module/id[0]", "properties": { "___proto__": [ "es5:String/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/modules.html#module.id", "doc": "The identifier for the module. Typically this is the fully resolved filename.
\n" } ], "_loaded": [ { "guid": "nodejs_latest:module/loaded[0]", "properties": { "___proto__": [ "es5:Boolean/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/modules.html#module.loaded", "doc": "Identifies wether or not the module is done loading (true), or is in the\nprocess of loading.
The module that required this one.
\n" } ], "_require": [ { "guid": "nodejs_latest:module/require[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/modules.html#module.require", "doc": "The module.require method provides a way to load a module as if require()\nwas called from the original module. The object returned is actually the\nexports from the resolved module.\n
Construct a new socket object and opens a socket to the given location. When the\nsocket is established, the 'connect' event is emitted.\n
Construct a new socket object and opens a socket to the given location. When the\nsocket is established, the 'connect' event is emitted.\n
Creates a new TCP server.\n
\n", "fargs": [ { "id": "options", "type": [ "es5:Object/prototype" ], "opt": true }, { "id": "connectionListener", "type": [ "es5:Object/prototype" ], "opt": true } ] } ], "_isIP": [ { "guid": "nodejs_latest:net/isIP[0]", "properties": { "_return": [ "es5:String/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/net.html#net.isIP", "doc": "Tests if input is an IP address. Returns 0 for invalid strings, returns 4\nfor IP version 4 addresses, and returns 6 for IP version 6 addresses.
Returns true if input is a version 4 IP address.
Returns true if input is a version 6 IP address.
The net module provides you with an asynchronous network wrapper. It contains\nmethods for creating both servers and clients (called streams). You can include\nthis module in your code with require('net');\n
Returns the bound address and port of the server as reported by the operating\nsystem. Useful to find which port was assigned when giving getting an\nOS-assigned address.\n
\n", "fargs": [] } ], "_close": [ { "guid": "nodejs_latest:net/Server/prototype/close[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/net.html#net.Server.close", "doc": "Stops the server from accepting new connections. This function is asynchronous,\nand the server is finally closed when it emits a `'close' event.
\n", "fargs": [] } ], "_connections": [ { "guid": "nodejs_latest:net/Server/prototype/connections[0]", "properties": { "___proto__": [ "es5:Number/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/net.html#net.Server.connections", "doc": "The number of concurrent connections on the server.
\n" } ], "_listen": [ { "guid": "nodejs_latest:net/Server/prototype/listen[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/net.html#net.Server.listen", "doc": "Begin accepting connections on the specified port and host. If the host\nis omitted, the server accepts connections directed to any IPv4 address\n(INADDR_ANY). A port value of zero will assign a random port.\n
Set this property to reject connections when the server's connection count gets\nhigh.
\n" } ], "_pause": [ { "guid": "nodejs_latest:net/Server/prototype/pause[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/net.html#net.Server.pause", "doc": "Stop accepting connections for the given number of milliseconds. This could be\nuseful for throttling new connections against DoS attacks or other\noversubscriptions.
\n", "fargs": [ { "id": "msecs", "type": [ "es5:Object/prototype" ] } ] } ], "_listen(process.env.PORT, process.env.IP)": [ { "guid": "nodejs_latest:net/Server/prototype/listen[0c9listenhack]", "doc": "Begin accepting connections in a Cloud9 environment." } ] } } ] }, "kind": "hidden", "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/net.html#net.Server", "doc": "This class is used to create a TCP or UNIX server. A server is a net.Socket\nthat can listen for new incoming connections.\n
Returns the bound address and port of the socket as reported by the operating\nsystem. Returns an object with two properties that looks like this:\n
\n", "fargs": [] } ], "_bufferSize": [ { "guid": "nodejs_latest:net/Socket/prototype/bufferSize[0]", "properties": { "___proto__": [ "es5:Number/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/net.html#net.Socket.bufferSize", "doc": "net.Socket has the property that socket.write() always works. This is to\nhelp users get up and running quickly. The computer can't always keep up with\nthe amount of data that is written to a socket—the network connection simply\nmight be too slow. Node.js will internally queue up the data written to a socket\nand send it out over the wire whenever it's possible. (Internally, it's polling\non the socket's file descriptor for being writable.)\n
The amount of received bytes.
\n" } ], "_bytesWritten": [ { "guid": "nodejs_latest:net/Socket/prototype/bytesWritten[0]", "properties": { "___proto__": [ "es5:Number/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/net.html#net.Socket.bytesWritten", "doc": "The amount of bytes sent.
\n" } ], "_close": [ { "guid": "nodejs_latest:net/Socket/prototype/close[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/net.html#net.Socket.close", "doc": "Emitted once the socket is fully closed.
\n", "fargs": [ { "id": "had_error", "type": [ "es5:Object/prototype" ] } ] } ], "_connect": [ { "guid": "nodejs_latest:net/Socket/prototype/connect[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/net.html#net.Socket.connect", "doc": "Opens the connection for a given socket. If port and host are given, then\nthe socket is opened as a TCP socket. If a path is given, the socket is opened\nas a Unix socket to that path.\n
Ensures that no more I/O activity happens on this socket. Only necessary in case\nof errors (like with a parse error).
\n", "fargs": [] } ], "_drain": [ { "guid": "nodejs_latest:net/Socket/prototype/drain[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/net.html#net.Socket.drain", "doc": "(related to: net.Socket.write)\n
\n", "fargs": [] } ], "_end": [ { "guid": "nodejs_latest:net/Socket/prototype/end[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/net.html#net.Socket.end", "doc": "Half-closes the socket, i.e., it sends a FIN packet. It is possible the server\ncan still send some data.\n
\n", "fargs": [ { "id": "data", "type": [ "es5:Object/prototype" ], "opt": true }, { "id": "encoding", "type": [ "es5:Object/prototype" ], "opt": true } ] } ], "_error": [ { "guid": "nodejs_latest:net/Socket/prototype/error[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/net.html#net.Socket.error", "doc": "Emitted when an error occurs. The 'close' event is called directly following\nthis event.
Constructs a new socket object.\n
\n", "fargs": [ { "id": "options", "type": [ "es5:Object/prototype" ], "opt": true } ] } ], "_pause": [ { "guid": "nodejs_latest:net/Socket/prototype/pause[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/net.html#net.Socket.pause", "doc": "Pauses the reading of data. That is, 'data' events are no longer emitted.\nUseful to throttle back an upload.
The string representation of the remote IP address. For example,\n'74.125.127.100' or '2001:4860:a005::68'.
The numeric representation of the remote port. For example, 80 or 21.
Resumes reading after a call to pause().
Sets the encoding for data that is received.
\n", "fargs": [ { "id": "encoding", "type": [ "es5:Object/prototype" ], "opt": true } ] } ], "_setKeepAlive": [ { "guid": "nodejs_latest:net/Socket/prototype/setKeepAlive[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/net.html#net.Socket.setKeepAlive", "doc": "Enable and disable keep-alive functionality, and optionally set the initial\ndelay before the first keepalive probe is sent on an idle socket.\n
\n", "fargs": [ { "id": "enable", "type": [ "es5:Object/prototype" ], "opt": true }, { "id": "initialDelay", "type": [ "es5:Object/prototype" ], "opt": true } ] } ], "_setNoDelay": [ { "guid": "nodejs_latest:net/Socket/prototype/setNoDelay[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/net.html#net.Socket.setNoDelay", "doc": "Disables the Nagle algorithm.\nBy default TCP connections use the Nagle algorithm, they buffer data before\nsending it off.
\n", "fargs": [ { "id": "noDelay", "type": [ "es5:Object/prototype" ], "opt": true } ] } ], "_setSecure": [ { "guid": "nodejs_latest:net/Socket/prototype/setSecure[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/net.html#net.Socket.setSecure", "doc": "(deprecated: 0.3.0)\n
\n", "fargs": [] } ], "_setTimeout": [ { "guid": "nodejs_latest:net/Socket/prototype/setTimeout[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/net.html#net.Socket.setTimeout", "doc": "Sets the socket to timeout after timeout milliseconds of inactivity on the\nsocket. By default net.Socket don't have a timeout.\n
(related to: net.Socket.setTimeout)\n
\n", "fargs": [] } ], "_write": [ { "guid": "nodejs_latest:net/Socket/prototype/write[0]", "properties": { "_return": [ "es5:Boolean/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/net.html#net.Socket.write", "doc": "Sends data on the socket. The second parameter specifies the encoding in the\ncase of a string—it defaults to UTF8 encoding.\n
\n", "fargs": [ { "id": "data", "type": [ "es5:Object/prototype" ] }, { "id": "encoding", "type": [ "es5:Object/prototype" ], "opt": true }, { "id": "callback", "type": [ "es5:Object/prototype" ], "opt": true, "fargs": [] } ] } ] } } ], "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "kind": "hidden", "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/net.html#net.Socket", "doc": "This object is an abstraction of a TCP or UNIX socket. net.Socket instances\nimplement a duplex Stream interface. They can be created by the user and used\nas a client (with connect()) or they can be created by Node.js and passed to\nthe user through the 'connection' event of a server.
Returns the operating system CPU architecture.
\n", "fargs": [] } ], "_cpus": [ { "guid": "nodejs_latest:os/cpus[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/os.html#os.cpus", "doc": "Returns an array of objects containing information about each CPU/core\ninstalled: the model, speed (in MHz), and times (an object containing the number\nof CPU ticks spent in: user, nice, sys, idle, and irq).\n
\n", "fargs": [] } ], "_freemem": [ { "guid": "nodejs_latest:os/freemem[0]", "properties": { "_return": [ "es5:Number/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/os.html#os.freemem", "doc": "Returns the amount of free system memory in bytes.
\n", "fargs": [] } ], "_hostname": [ { "guid": "nodejs_latest:os/hostname[0]", "properties": { "_return": [ "es5:String/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/os.html#os.hostname", "doc": "Returns the hostname of the operating system.
\n", "fargs": [] } ], "_loadavg": [ { "guid": "nodejs_latest:os/loadavg[0]", "properties": { "_return": [ "es5:Number/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/os.html#os.loadavg", "doc": "Returns an array containing the 1, 5, and 15 minute load averages.
\n", "fargs": [] } ], "_networkInterfaces": [ { "guid": "nodejs_latest:os/networkInterfaces[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/os.html#os.networkInterfaces", "doc": "Returns a list of network interfaces.\n
\n", "fargs": [] } ], "_platform": [ { "guid": "nodejs_latest:os/platform[0]", "properties": { "_return": [ "es5:String/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/os.html#os.platform", "doc": "Returns the operating system platform.
\n", "fargs": [] } ], "_release": [ { "guid": "nodejs_latest:os/release[0]", "properties": { "_return": [ "es5:String/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/os.html#os.release", "doc": "Returns the operating system release.
\n", "fargs": [] } ], "_totalmem": [ { "guid": "nodejs_latest:os/totalmem[0]", "properties": { "_return": [ "es5:Number/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/os.html#os.totalmem", "doc": "Returns the total amount of system memory in bytes.
\n", "fargs": [] } ], "_type": [ { "guid": "nodejs_latest:os/type[0]", "properties": { "_return": [ "es5:String/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/os.html#os.type", "doc": "Returns the operating system name.
\n", "fargs": [] } ], "_uptime": [ { "guid": "nodejs_latest:os/uptime[0]", "properties": { "_return": [ "es5:Number/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/os.html#os.uptime", "doc": "Returns the system uptime in seconds.
\n", "fargs": [] } ] }, "kind": "package", "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/os.html#os", "doc": "This provides a way to retrieve various information about the underlaying\noperating system. Add require('os') in your code to access this module.\n
Return the last portion of a path. Similar to the Unix\nbasename command.\n
Return the directory name of a path. Similar to the Unix\ndirname command.\n
Tests whether or not the given path exists by checking with the file system.\n
\n", "fargs": [ { "id": "p", "type": [ "es5:Object/prototype" ] }, { "id": "callback", "type": [ "es5:Object/prototype" ], "opt": true, "fargs": [ { "id": "exists", "type": [ "es5:Boolean/prototype" ] } ] } ] } ], "_existsSync": [ { "guid": "nodejs_latest:path/existsSync[0]", "properties": { "_return": [ "es5:Boolean/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/path.html#path.existsSync", "doc": "The synchronous version of path.exists. Tests whether or not the given path\nexists by checking with the file system\n
Return the extension of the path, from the last '.' to end of string in the last\nportion of the path. If there is no '.' in the last portion of the path or the\nfirst character of it is '.', then the method returns an empty string.\n
\n", "fargs": [ { "id": "p", "type": [ "es5:Object/prototype" ] } ] } ], "_join": [ { "guid": "nodejs_latest:path/join[0]", "properties": { "_return": [ "es5:String/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/path.html#path.join", "doc": "Join all arguments together and normalize the resulting path. Non-string\narguments are ignored.\n
\n", "fargs": [ { "id": "path1", "type": [ "es5:Object/prototype" ] }, { "id": "path2", "type": [ "es5:Object/prototype" ] }, { "id": "paths", "type": [ "es5:Object/prototype" ], "opt": true } ] } ], "_normalize": [ { "guid": "nodejs_latest:path/normalize[0]", "properties": { "_return": [ "es5:String/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/path.html#path.normalize", "doc": "Normalize a string path, taking care of '..' and '.' parts.\n
Solve the relative path from from to to.\n
Resolves to to an absolute path.\n
This module contains utilities for handling and transforming file paths. Add\nrequire('path') to your code to use this module.\n
Identifies which processor architecture you're running on: 'arm', 'ia32', or\n'x64'.\n
An array containing the command line arguments. The first element is 'node',\nand the second element is the name of the Javascript file. The next elements\nwill be any additional command line arguments.\n
\n" } ], "_chdir": [ { "guid": "nodejs_latest:process/chdir[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/process.html#process.chdir", "doc": "Changes the current working directory of the process or throws an exception if\nthat fails.\n
\n", "fargs": [ { "id": "directory", "type": [ "es5:Object/prototype" ] } ] } ], "_cwd": [ { "guid": "nodejs_latest:process/cwd[0]", "properties": { "_return": [ "es5:String/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/process.html#process.cwd", "doc": "Returns the current working directory of the process. For example:\n
\n", "fargs": [] } ], "_env": [ { "guid": "nodejs_latest:process/env[0]", "properties": { "___proto__": [ "es5:Object/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/process.html#process.env", "doc": "An object containing the user environment. For more information, see\nenviron(7).
\n" } ], "_execPath": [ { "guid": "nodejs_latest:process/execPath[0]", "properties": { "___proto__": [ "es5:String/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/process.html#process.execPath", "doc": "This is the absolute pathname of the executable that started the process.\n
\n" } ], "_exit": [ { "guid": "nodejs_latest:process/exit[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/process.html#process.exit", "doc": "Ends the process with the specified code.\n
Gets the group identity of the process. This is the numerical group id, not the\ngroup name. For more information, see\ngetgid(2).\n
\n", "fargs": [] } ], "_getuid": [ { "guid": "nodejs_latest:process/getuid[0]", "properties": { "_return": [ "es5:Number/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/process.html#process.getuid", "doc": "Gets the user identity of the process. Note that this is the numerical userid,\nnot the username. For more information, see\ngetuid(2).\n
\n", "fargs": [] } ], "_installPrefix": [ { "guid": "nodejs_latest:process/installPrefix[0]", "properties": { "___proto__": [ "es5:String/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/process.html#process.installPrefix", "doc": "A compiled-in property that exposes the NODE_PREFIX.\n
Send a signal to a process. The signal names are strings like 'SIGINT' or\n'SIGUSR1'. For more information, see\nkill(2).\n
Returns an object describing the memory usage of the Node.js process measured in\nbytes.\n
\n", "fargs": [] } ], "_nextTick": [ { "guid": "nodejs_latest:process/nextTick[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/process.html#process.nextTick", "doc": "On the next loop around the event loop call this callback. This is not a\nsimple alias to setTimeout(fn, 0); it's much more efficient.\n
Returns the PID of the process.\n
\n" } ], "_platform": [ { "guid": "nodejs_latest:process/platform[0]", "properties": { "___proto__": [ "es5:String/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/process.html#process.platform", "doc": "Identifies the platform you're running on, like 'linux2', 'darwin', etc.\n
Sets the group identity of the process. This accepts either a numerical ID or a\ngroupname string. If a groupname is specified, this method blocks while\nresolving it to a numerical ID. For more information, see\nsetgid(2).\n
\n", "fargs": [ { "id": "id", "type": [ "es5:Object/prototype" ] } ] } ], "_setuid": [ { "guid": "nodejs_latest:process/setuid[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/process.html#process.setuid", "doc": "Sets the user identity of the process. This accepts either a numerical ID or a\nusername string. If a username is specified, this method blocks while resolving\nit to a numerical ID. For more information, see\nsetuid(2).\n
\n", "fargs": [ { "id": "id", "type": [ "es5:Object/prototype" ] } ] } ], "_stderr": [ { "guid": "nodejs_latest:process/stderr[0]", "properties": { "___proto__": [ "nodejs_latest:fs/WriteStream/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/process.html#process.stderr", "doc": "A writable stream to stderr.\n
\n" } ], "_stdin": [ { "guid": "nodejs_latest:process/stdin[0]", "properties": { "___proto__": [ "nodejs_latest:fs/ReadStream/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/process.html#process.stdin", "doc": "A Readable Stream for stdin. The stdin stream is paused by default, so one\nmust call process.stdin.resume() to read from it.\n
A writable stream to stdout.\n
A getter and setter to set what is displayed in ps.
Sets or reads the process's file mode creation mask. Child processes inherit the\nmask from the parent process. Returns the old mask if mask argument is given,\notherwise returns the current mask.\n
Returns the number of seconds Node.js has been running.
\n", "fargs": [] } ], "_version": [ { "guid": "nodejs_latest:process/version[0]", "properties": { "___proto__": [ "es5:String/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/process.html#process.version", "doc": "A compiled-in property that exposes the NODE_VERSION.\n
A property exposing version strings of Node.js and its dependencies.\n
\n" } ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/process.html#process", "doc": "The process object is a global object, and can be accessed from anywhere. It\nis an instance of EventEmitter.\n
The escape function used by querystring.stringify(), provided so that it can\nbe overridden, if necessary.
Deserialize a query string to an object and returns it. You can choose to\noverride the default separator and assignment characters.\n
\n", "fargs": [ { "id": "str", "type": [ "es5:Object/prototype" ] }, { "id": "sep", "type": [ "es5:Object/prototype" ], "opt": true }, { "id": "eq", "type": [ "es5:Object/prototype" ], "opt": true } ] } ], "_stringify": [ { "guid": "nodejs_latest:querystring/stringify[0]", "properties": { "_return": [ "es5:String/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/querystring.html#querystring.stringify", "doc": "Serialize an object to a query string and returns it. You can choose to override\nthe default separator and assignment characters.\n
\n", "fargs": [ { "id": "obj", "type": [ "es5:Object/prototype" ] }, { "id": "sep", "type": [ "es5:Object/prototype" ], "opt": true }, { "id": "eq", "type": [ "es5:Object/prototype" ], "opt": true } ] } ], "_unescape": [ { "guid": "nodejs_latest:querystring/unescape[0]", "properties": { "_return": [ "es5:String/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/querystring.html#querystring.unescape", "doc": "The unescape() function, used by querystring.parse(), is provided so that it\ncan be overridden if necessary.
This module provides utilities for dealing with query strings in URLs. To\ninclude this module, add require('querystring') to your code.\n
Takes two streams and creates a readline interface.\n
\n", "fargs": [ { "id": "input", "type": [ "es5:Object/prototype" ] }, { "id": "output", "type": [ "es5:Object/prototype" ], "opt": true }, { "id": "completer", "type": [ "es5:Object/prototype" ], "fargs": [] } ] } ] }, "kind": "package", "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/readline.html#readline", "doc": "Readline allows you to read of a stream (such as STDIN) on a line-by-line basis.\nTo use this module, add require('readline') to your code.\n
Closes the tty. Without this call, your program will run indefinitely.
Pauses the tty.
Readies the readline for input from the user, putting the current setPrompt\noptions on a new line, giving the user a new spot to write.
Prepends the prompt with query and invokes callback with the user's respons\nafter it has been entered.\n
Resumes tty.
Sets the prompt character. For example, when you run node on the command line,\nyou'll see > , which is Node's prompt.
Writes to the tty.
The class that represents a readline interface with a stdin and stdout stream.
\n" }, "nodejs_latest:repl": { "guid": "nodejs_latest:repl", "properties": { "_prototype": [ { "guid": "nodejs_latest:repl/prototype", "properties": {} } ], "_start": [ { "guid": "nodejs_latest:repl/start[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/repl.html#repl.start", "doc": "Starts a REPL with prompt as the prompt and stream for all I/O.\n
A Read-Eval-Print-Loop (REPL) is available both as a standalone program and\neasily includable in other programs. REPL provides a way to interactively run\nJavascript and see the results. It can be used for debugging, testing, or just\ntrying things out.\n
\n" }, "nodejs_latest:socket": { "guid": "nodejs_latest:socket", "properties": { "_prototype": [ { "guid": "nodejs_latest:socket/prototype", "properties": {} } ] }, "kind": "package", "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/dgram.html#socket", "doc": "The dgram Socket class encapsulates the datagram functionality. It should be\ncreated via dgram.createSocket(type, [callback]).
A stream is an abstract interface implemented by various objects in Node.js. For\nexample, a request to an HTTP server is a stream, as is stdout. Streams can be\nreadable, writable, or both. All streams are instances of EventEmitter.\n
Closes the underlying file descriptor. The stream will not emit any more events.
\n", "fargs": [] } ], "_pause": [ { "guid": "nodejs_latest:streams/ReadableStream/prototype/pause[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/stream.html#streams.ReadableStream.pause", "doc": "Pause any incoming 'data' events.
This is the Stream.prototype() method available on all Stream objects. It\nconnects this read stream to a destination. Incoming data on this stream is\nthen written to destination. The destination and source streams are kept in\nsync by Node.js pausing and resuming as necessary.\n
Resumes the incoming 'data' events after a pause().
Closes the underlying file descriptor. The stream doesn't emit any more events.\nAny queued write data is not sent.
\n", "fargs": [] } ], "_destroySoon": [ { "guid": "nodejs_latest:streams/WritableStream/prototype/destroySoon[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/stream.html#streams.WritableStream.destroySoon", "doc": "After the write queue is drained, this closes the file descriptor.\ndestroySoon() can still destroy straight away, as long as there is no data\nleft in the queue for writes.
Terminates the stream with EOF or FIN. This call send queued write data before\nclosing the stream.\n
\n", "fargs": [] } ], "_writable": [ { "guid": "nodejs_latest:streams/WritableStream/prototype/writable[0]", "properties": { "___proto__": [ "es5:Boolean/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/stream.html#streams.WritableStream.writable", "doc": "A boolean that is true by default, but turns false after an error event\noccurs, the stream comes to an 'end', or if destroy() was called.
Writes string with the given encoding to the stream, or write buffer.\nReturns true if the string has been flushed to the kernel buffer. Returns\nfalse to indicate that the kernel buffer is full, and the data will be sent\nout in the future. The drain event indicates when the kernel buffer is empty\nagain.\n
StringDecoder decodes a buffer to a string. It is a simple interface\n to buffer.toString() but provides additional support for utf8.\n
Creates a new StringDecoder.
Returns a decoded string.
\n", "fargs": [ { "id": "buffer", "type": [ "es5:Object/prototype" ] } ] } ] }, "kind": "hidden", "fargs": [ { "id": "encoding", "type": [ "es5:Object/prototype" ] } ] }, "nodejs_latest:timer": { "guid": "nodejs_latest:timer", "properties": { "_prototype": [ { "guid": "nodejs_latest:timer/prototype", "properties": {} } ], "_clearInterval": [ { "guid": "nodejs_latest:timer/clearInterval[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/timers.html#timer.clearInterval", "doc": "Stops a interval from triggering.
\n", "fargs": [ { "id": "intervalId", "type": [ "es5:Object/prototype" ] } ] } ], "_clearTimeout": [ { "guid": "nodejs_latest:timer/clearTimeout[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/timers.html#timer.clearTimeout", "doc": "Prevents a timeout from triggering.
\n", "fargs": [ { "id": "timeoutId", "type": [ "es5:Object/prototype" ] } ] } ], "_setInterval": [ { "guid": "nodejs_latest:timer/setInterval[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/timers.html#timer.setInterval", "doc": "This schedules the repeated execution of a callback function after a defined\ndelay. It returns an intervalId for possible use with clearInterval().\nOptionally, you can also pass arguments to the callback.\n
The timer functions are useful for scheduling functions to run after a defined\namount of time. All of the objects in this class are global; the method calls\ndon't need to be prepended with an object name.\n
\n" }, "nodejs_latest:tls": { "guid": "nodejs_latest:tls", "properties": { "_prototype": [ { "guid": "nodejs_latest:tls/prototype", "properties": {} } ], "_connect": [ { "guid": "nodejs_latest:tls/connect[0]", "properties": { "_return": [ "nodejs_latest:tls/CleartextStream/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/tls.html#tls.connect", "doc": "Creates a new client connection to the given port and host. This function\nreturns a tls.CleartextStream object.\n
Creates a new secure pair object with two streams, one of which reads/writes\nencrypted data, and one reads/writes cleartext data. This function returns a\nSecurePair object with tls.CleartextStream and\nencrypted stream properties.\n
Creates a new tls.Server.\n
The tls module uses OpenSSL to provide both the Transport Layer Security and\nthe Secure Socket Layer; in other words, it provides encrypted stream\ncommunications. To access this module, add require('tls') in your code.\n
The reason why the peer's certificate has not been verified. This property\nbecomes available only when cleartextStream.authorized === false.
If true, the peer certificate was signed by one of the specified CAs;\notherwise, false.
Returns the bound address and port of the underlying socket as reported by the\noperating system. The object has two properties, e.g.\n{"address":"192.168.57.1", "port":62053}
Returns an object representing the peer's certificate. The returned object has\nsome properties corresponding to the field of the certificate.\n
\n", "fargs": [] } ], "_remoteAddress": [ { "guid": "nodejs_latest:tls/CleartextStream/prototype/remoteAddress[0]", "properties": { "___proto__": [ "es5:String/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/tls.html#tls.CleartextStream.remoteAddress", "doc": "The string representation of the remote IP address. For example,\n'74.125.127.100' or '2001:4860:a005::68'.
The numeric representation of the remote port. For example, 443.
This is a stream on top of the encrypted stream that makes it possible to\nread/write an encrypted data as a cleartext data.\n
\n" }, "nodejs_latest:tls/SecurePair": { "guid": "nodejs_latest:tls/SecurePair", "properties": { "_prototype": [ { "guid": "nodejs_latest:tls/SecurePair/prototype", "properties": {} } ] }, "kind": "hidden", "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/tls.html#tls.SecurePair", "doc": "Returned by tls.createSecurePair().
Add secure context that will be used if client request's SNI hostname is\nmatching passed hostname (wildcards can be used). credentials can contain\nkey, cert, and ca.\n
Returns the bound address and port of the server as reported by the operating\nsystem.\n
\n", "fargs": [] } ], "_close": [ { "guid": "nodejs_latest:tls/Server/prototype/close[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/tls.html#tls.Server.close", "doc": "Stops the server from accepting new connections. This function is asynchronous,\nand the server is finally closed when it emits a 'close' event.
The number of concurrent connections on the server.
\n" } ], "_listen": [ { "guid": "nodejs_latest:tls/Server/prototype/listen[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/tls.html#tls.Server.listen", "doc": "Begin accepting connections on the specified port and host. If the host\nis omitted, the server will accept connections directed to any IPv4 address\n(INADDR_ANY).\n
Set this property to reject connections when the server's connection count gets\nhigh.
\n" } ], "_pause": [ { "guid": "nodejs_latest:tls/Server/prototype/pause[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/tls.html#tls.Server.pause", "doc": "Stop accepting connections for the given number of milliseconds. This could be\nuseful for throttling new connections against DoS attacks or other\noversubscriptions.
\n", "fargs": [ { "id": "msecs", "type": [ "es5:Object/prototype" ] } ] } ] } } ] }, "kind": "hidden", "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/tls.html#tls.Server", "doc": "This class is a subclass of net.Server and has the same methods\nas it. However, instead of accepting just raw TCP connections, it also accepts\nencrypted connections using TLS or SSL.
This function no longer exists. Use process.stdout.getWindowSize() instead.
Returns true or false depending on if the file descriptor is associated with\na terminal.
This sets the properties of the current process's stdin file descriptor to act\neither as a raw device (true) or default (false).
This function no longer exists.
\n", "fargs": [ { "id": "fd", "type": [ "es5:Object/prototype" ] }, { "id": "row", "type": [ "es5:Object/prototype" ] }, { "id": "col", "type": [ "es5:Object/prototype" ] } ] } ] }, "kind": "package", "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/tty.html#tty", "doc": "This module controls printing to the terminal output. Use require('tty') to\naccess this module.\n
Takes a parsed URL object and returns a formatted URL string that contains these\nproperties:\n
\n", "fargs": [ { "id": "urlObj", "type": [ "es5:Object/prototype" ] } ] } ], "_parse": [ { "guid": "nodejs_latest:url/parse[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/url.html#url.parse", "doc": "Takes a URL string, and return it as an object.
\n", "fargs": [ { "id": "urlStr", "type": [ "es5:Object/prototype" ] }, { "id": "parseQueryString", "type": [ "es5:Object/prototype" ], "opt": true }, { "id": "slashesDenoteHost", "type": [ "es5:Object/prototype" ], "opt": true } ] } ], "_resolve": [ { "guid": "nodejs_latest:url/resolve[0]", "properties": { "_return": [ "es5:String/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/url.html#url.resolve", "doc": "Takes a base URL, and an href URL, and resolves them as a browser would for an\nanchor tag.\n
\n", "fargs": [ { "id": "from", "type": [ "es5:Object/prototype" ] }, { "id": "to", "type": [ "es5:Object/prototype" ] } ] } ] }, "kind": "package", "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/url.html#url", "doc": "This module has utilities for URL resolution and parsing. To use it, add\nrequire('url') to your code.\n
A synchronous output function. This block the process and outputs string\nimmediately to stderr.
Same as util.debug() except this will output all arguments immediately to\nstderr.
Returns a formatted string using the first argument in a\nprintf()-like way.\n
Inherit the prototype methods from one constructor into another. The prototype\nof constructor is set to a new object created from superConstructor.\n
Returns a string representation of object, which is useful for debugging.\n
Returns true if the given object is an Array.\n
Returns true if the given object is a Date.\n
Returns true if the given object is an Error.\n
Returns true if the given "object" is a RegExp.\n
Outputs to stdout...but with a timestamp!
A synchronous output function. Will block the process, cast each argument to a\nstring then output to stdout. Does not place newlines after each argument.
Reads the data from readableStream and sends it to the writableStream.\n
A synchronous output function. Will block the process and output all arguments\nto stdout with newlines after each argument.
vm.createContext() creates a new context which is suitable for use as the\nsecond argument of a subsequent call to vm.runInContext().\n
This script can be run later many times using the other vm methods. In case of\nsyntax error in code, createScript prints the syntax error to stderr and\nthrows an exception.\n
vm.runInContext() compiles code, then runs it in context and returns the\nresult.\n
vm.runInNewContext() compiles code then runs it in sandbox and returns the\nresult. Running code does not have access to local scope. The object sandbox\nis used as the global object for code.\nsandbox and filename are optional, and filename is only used in stack\ntraces.\n
vm.runInThisContext() compiles code as if it were loaded from filename,\nruns it, and returns the result. Running code does not have access to local\nscope. The filename is optional, and is only used in stack traces.\n
In Node.js, Javascript code can be compiled and run immediately or compiled,\nsaved, and run later. To do that, you can add require('vm'); to your code.\n
Similar to vm.runInNewContext(), this is a method of a precompiled Script\nobject.\n
Similar to vm.runInThisContext(), but a method of the precompiled Script\nobject.\n
This object is created as a result of the vm.createScript() method. It represents some compiled code than can be run\nat a later moment.
This function kills the worker, and inform the master to not spawn a new worker.\nTo know the difference between suicide and accidentally death, a suicide boolean\nis set to true.\n
When calling this function the worker will no longer accept new connections, but\nthey will be handled by any other listening worker. Existing connection will be\nallowed to exit as usual. When no more connections exist, the IPC channel to the\nworker will close allowing it to die graceful. When the IPC channel is closed\nthe disconnect event will emit, this is then followed by the death event,\nthere is emitted when the worker finally die.\n
Since all workers are created using child_process.fork(), the returned object from that function is stored in\nprocess.\n
This function is equal to the send methods provided by child_process.fork().\nIn the master, you should use this function to\nsend a message to a specific worker. However, in a worker you can also use\nprocess.send(message), since this is the same function.\n
This property is a boolean. It is set when a worker dies after calling\ndestroy() or immediately after calling the disconnect() method. Until then,\nit is undefined.
Each new worker is given its own unique id, stored in the uniqueID.\n
A Worker object contains all public information and methods about a worker. In\nthe master, it can be obtained using cluster.workers. In a worker it can be\nobtained using cluster.worker.
Returns a new object for compressing using deflate.
\n", "fargs": [ { "id": "options", "type": [ "es5:Object/prototype" ], "opt": true } ] } ], "_createDeflateRaw": [ { "guid": "nodejs_latest:zlib/createDeflateRaw[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/zlib.html#zlib.createDeflateRaw", "doc": "Returns a new object for compressing using deflate, without an appended zlib\nheader.
\n", "fargs": [ { "id": "options", "type": [ "es5:Object/prototype" ], "opt": true } ] } ], "_createGunzip": [ { "guid": "nodejs_latest:zlib/createGunzip[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/zlib.html#zlib.createGunzip", "doc": "Returns a new object for Gunzip compression.
\n", "fargs": [ { "id": "options", "type": [ "es5:Object/prototype" ], "opt": true } ] } ], "_createGzip": [ { "guid": "nodejs_latest:zlib/createGzip[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/zlib.html#zlib.createGzip", "doc": "Returns a new Object for Gzip compression.
\n", "fargs": [ { "id": "options", "type": [ "es5:Object/prototype" ], "opt": true } ] } ], "_createInflate": [ { "guid": "nodejs_latest:zlib/createInflate[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/zlib.html#zlib.createInflate", "doc": "Returns a new object to decompress a deflate stream.
\n", "fargs": [ { "id": "options", "type": [ "es5:Object/prototype" ], "opt": true } ] } ], "_createInflateRaw": [ { "guid": "nodejs_latest:zlib/createInflateRaw[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/zlib.html#zlib.createInflateRaw", "doc": "Returns a new object to decompress a raw deflate stream (one without an appended\nzlib header).
\n", "fargs": [ { "id": "options", "type": [ "es5:Object/prototype" ], "opt": true } ] } ], "_createUnzip": [ { "guid": "nodejs_latest:zlib/createUnzip[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/zlib.html#zlib.createUnzip", "doc": "Returns a new unzip to decompress either a Gzip- or Deflate-compressed stream by\nauto-detecting the header.
\n", "fargs": [ { "id": "options", "type": [ "es5:Object/prototype" ], "opt": true } ] } ], "_deflate": [ { "guid": "nodejs_latest:zlib/deflate[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/zlib.html#zlib.deflate", "doc": "Compresses a buffer using deflate.
\n", "fargs": [ { "id": "buf", "type": [ "es5:Object/prototype" ] }, { "id": "callback", "type": [ "es5:Object/prototype" ], "fargs": [ { "id": "error", "type": [ "es5:Error/prototype" ] }, { "id": "result", "type": [ "es5:Object/prototype" ] } ] } ] } ], "_deflateRaw": [ { "guid": "nodejs_latest:zlib/deflateRaw[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/zlib.html#zlib.deflateRaw", "doc": "Compresses a buffer using a raw deflate stream (one without an appended zlib\nheader).
\n", "fargs": [ { "id": "buf", "type": [ "es5:Object/prototype" ] }, { "id": "callback", "type": [ "es5:Object/prototype" ], "fargs": [ { "id": "error", "type": [ "es5:Error/prototype" ] }, { "id": "result", "type": [ "es5:Object/prototype" ] } ] } ] } ], "_gunzip": [ { "guid": "nodejs_latest:zlib/gunzip[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/zlib.html#zlib.gunzip", "doc": "Decompress a buffer with Gunzip.
\n", "fargs": [ { "id": "buf", "type": [ "es5:Object/prototype" ] }, { "id": "callback", "type": [ "es5:Object/prototype" ], "fargs": [ { "id": "error", "type": [ "es5:Error/prototype" ] }, { "id": "result", "type": [ "es5:Object/prototype" ] } ] } ] } ], "_gzip": [ { "guid": "nodejs_latest:zlib/gzip[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/zlib.html#zlib.gzip", "doc": "Compresses a buffer using Gzip.
\n", "fargs": [ { "id": "buf", "type": [ "es5:Object/prototype" ] }, { "id": "callback", "type": [ "es5:Object/prototype" ], "fargs": [ { "id": "error", "type": [ "es5:Error/prototype" ] }, { "id": "result", "type": [ "es5:Object/prototype" ] } ] } ] } ], "_inflate": [ { "guid": "nodejs_latest:zlib/inflate[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/zlib.html#zlib.inflate", "doc": "Decompress a buffer with Inflate.
\n", "fargs": [ { "id": "buf", "type": [ "es5:Object/prototype" ] }, { "id": "callback", "type": [ "es5:Object/prototype" ], "fargs": [ { "id": "error", "type": [ "es5:Error/prototype" ] }, { "id": "result", "type": [ "es5:Object/prototype" ] } ] } ] } ], "_inflateRaw": [ { "guid": "nodejs_latest:zlib/inflateRaw[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/zlib.html#zlib.inflateRaw", "doc": "Decompress a raw buffer with a raw deflate stream (one without an appended zlib\nheader)..
\n", "fargs": [ { "id": "buf", "type": [ "es5:Object/prototype" ] }, { "id": "callback", "type": [ "es5:Object/prototype" ], "fargs": [ { "id": "error", "type": [ "es5:Error/prototype" ] }, { "id": "result", "type": [ "es5:Object/prototype" ] } ] } ] } ], "_options": [ { "guid": "nodejs_latest:zlib/options[0]", "properties": { "___proto__": [ "es5:Object/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/zlib.html#zlib.options", "doc": "Each class takes an optional options object. All options are optional. (The\nconvenience methods use the default settings for all options.)\n
\n" } ], "_unzip": [ { "guid": "nodejs_latest:zlib/unzip[0]", "properties": { "_return": [ "es5:Object/prototype" ], "___proto__": [ "es5:Function/prototype" ] }, "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/zlib.html#zlib.unzip", "doc": "Decompress a buffer with Unzip.
\n", "fargs": [ { "id": "buf", "type": [ "es5:Object/prototype" ] }, { "id": "callback", "type": [ "es5:Object/prototype" ], "fargs": [ { "id": "error", "type": [ "es5:Error/prototype" ] }, { "id": "result", "type": [ "es5:Object/prototype" ] } ] } ] } ] }, "kind": "package", "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/zlib.html#zlib", "doc": "This provides bindings to Gzip/Gunzip, Deflate/Inflate, and\nDeflateRaw/InflateRaw classes. Each class takes the same options, and is a\nreadable/writable Stream.\n
\n" }, "nodejs_latest:Addons": { "guid": "nodejs_latest:Addons", "properties": { "_prototype": [ { "guid": "nodejs_latest:Addons/prototype", "properties": {} } ] }, "kind": "hidden", "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/addons.html#Addons", "doc": "Addons are dynamically linked shared objects. They can provide glue to C and\nC++ libraries. The API (at the moment) is rather complex, involving\nknowledge of several libraries:\n
\n" }, "nodejs_latest:Debugger": { "guid": "nodejs_latest:Debugger", "properties": { "_prototype": [ { "guid": "nodejs_latest:Debugger/prototype", "properties": {} } ] }, "kind": "hidden", "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/debugger.html#Debugger", "doc": "V8 comes with an extensive debugger which is accessible out-of-process via a\nsimple TCP protocol.\n
\n" }, "nodejs_latest:Domain": { "guid": "nodejs_latest:Domain", "properties": { "_prototype": [ { "guid": "nodejs_latest:Domain/prototype", "properties": {} } ] }, "kind": "hidden", "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/domain.html#Domain", "doc": "Domains provide a way to handle multiple different IO operations as a\nsingle group. If any of the event emitters or callbacks registered to a\ndomain emit an error event, or throw an error, then the domain object\nwill be notified, rather than losing the context of the error in the\nprocess.on('uncaughtException') handler, or causing the program to\nexit with an error code.\n
These objects are available to all modules. Some of these objects aren't\nactually in the global scope, but in the module scope; they'll be noted as such\nbelow.\n
\n" }, "nodejs_latest:Index": { "guid": "nodejs_latest:Index", "properties": { "_prototype": [ { "guid": "nodejs_latest:Index/prototype", "properties": {} } ] }, "kind": "hidden", "docUrl": "http://nodemanual.org/latest/nodejs_ref_guide/index.html#Index", "doc": "Node.js is a server-side Javascript environment. It's event-driven,\nasynchronous, and allows you to write a web server in a relatively quick amount\nof time.\n
\n" } }