js.node

..
buffer
child_process
console
events
fs
http
https
net
stream
tls
url
zlib
Buffer

ChildProcess

ChildProcessExecCallback

A callback type for ChildProcess.exec. It receives three arguments: error, stdout, stderr.

ChildProcessExecError

An error passed to the ChildProcess.exec callback.

ChildProcessExecFileOptions

Options for the execFile method.

ChildProcessExecOptions

Options for the exec method.

ChildProcessForkOptions

Options for the fork method.

ChildProcessSpawnOptions

Options for the spawn method.

ChildProcessSpawnOptionsStdio

The stdio option is an array where each index corresponds to a fd in the child. The value is one of the following:

ChildProcessSpawnOptionsStdioBehaviour

Enumeration of possible stdio behaviours.

ChildProcessSpawnOptionsStdioFull

ChildProcessSpawnOptionsStdioSimple

A shorthand for the stdio argument in ChildProcessSpawnOptions

ChildProcessSpawnSyncOptions

Options for the spawnSync method.

ChildProcessSpawnSyncResult

Object returned from the spawnSync method.

Dns

This module contains functions that belong to two different categories:

DnsAddressFamily

Enumeration of possible Int options values for Dns.lookup.

DnsError

Error objects returned by dns lookups are of this type

DnsErrorCode

Each DNS query can return one of the following error codes

DnsLookupCallbackAll

DnsLookupCallbackAllEntry

DnsLookupCallbackSingle

DnsLookupOptions

Type of the options argument for Dns.lookup.

DnsResolvedAddress

DnsResolvedAddressMX

Types of address data returned by resolve functions.

DnsResolvedAddressSOA

DnsResolvedAddressSRV

DnsRrtype

Enumeration of possible rrtype value for Dns.resolve.

Fs

File I/O is provided by simple wrappers around standard POSIX functions. All the methods have asynchronous and synchronous forms.

FsConstants

Constants for use in Fs module.

FsCreateReadStreamOptions

Options for Fs.createReadStream.

FsCreateWriteStreamOptions

Options for Fs.createWriteStream.

FsMode

The mode argument used by Fs.open and related functions can be either an integer or a string with octal number.

FsOpenFlag

Enumeration of possible flags for opening file.

FsPath

Most FS functions now support passing String and Buffer. This type is used for path arguments and allows passing either of those.

FsRmdirOptions

Options for Fs.rmdir and Fs.rmdirSync.

FsWatchFileOptions

Possible options for Fs.watchFile.

FsWriteFileOptions

Possible options for Fs.writeFile and Fs.appendFile.

Http

The HTTP interfaces in Node are designed to support many features of the protocol which have been traditionally difficult to use. In particular, large, possibly chunk-encoded, messages. The interface is careful to never buffer entire requests or responses--the user is able to stream data.

HttpCreateServerOptions

HttpRequestOptions

Type of the options object passed to Http.request.

Https

HTTPS is the HTTP protocol over TLS/SSL. In Node.js this is implemented as a separate module.

HttpsCreateServerOptions

HttpsRequestOptions

IStream

IStream interface is used as "any Stream".

Immediate

This object is created internally and is returned from setImmediate(). It can be passed to clearImmediate() in order to cancel the scheduled actions.

InspectOptions

Options object used by Util.inspect.

InspectOptionsBase

Options object used by Console.dir.

Iterator

IteratorStep

KeyValue

Key/value access helper.

MemoryUsage

Module

In each module, the module free variable is a reference to the object representing the current module. For convenience, module.exports is also accessible via the exports module-global. module is not actually a global but rather local to each module.

Path

The path module provides utilities for working with file and directory paths.

PathObject

Path object returned from Path.parse and taken by Path.format.

Process

ProcessEvent

Enumeration of events emitted by the Process class.

Release

Report

Stream

Base class for all streams.

SymlinkType

Enumeration of possible symlink types

Timeout

This object is created internally and is returned from setTimeout() and setInterval(). It can be passed to either clearTimeout() or clearInterval() in order to cancel the scheduled actions.

Timers

The timer module exposes a global API for scheduling functions to be called at some future period of time. Because the timer functions are globals, there is no need to call require('timers') to use the API.

Tls

The tls module uses OpenSSL to provide Transport Layer Security and/or Secure Socket Layer: encrypted stream communication.

TlsClientOptionsBase

TlsConnectOptions

TlsCreateServerOptions

Base structure for options object used in tls methods.

TlsOptionsBase

TlsServerOptionsBase

Util

The util module is primarily designed to support the needs of Node.js' own internal APIs.

V8

The v8 module exposes APIs that are specific to the version of V8 built into the Node.js binary.

V8HeapSpaceStatistics

Object returned by V8.getHeapSpaceStatistics method.

V8HeapStatistics

Object returned by V8.getHeapStatistics method.

Zlib

This provides bindings to Gzip/Gunzip, Deflate/Inflate, and DeflateRaw/InflateRaw classes. Each class takes the same options, and is a readable/writable Stream.

ZlibOptions