js.node

..
assert
buffer
child_process
cluster
console
crypto
dgram
domain
events
fs
http
https
net
readline
repl
stream
tls
tty
url
util
vm
zlib
Assert

The assert module provides a set of assertion functions for verifying invariants. The module provides a recommended strict mode and a more lenient legacy mode.

Buffer

CPU

Object containing information about each CPU/core installed. Returned by Os.cpus method.

CPUTime

Object containing the number of milliseconds the CPU/core spent in: user, nice, sys, idle, and irq

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.

ClearLineDirection

Enumeration of possible directions for Readline.clearLine.

Cluster

A single instance of Node runs in a single thread. To take advantage of multi-core systems the user will sometimes want to launch a cluster of Node processes to handle the load. The cluster module allows you to easily create child processes that all share server ports.

ClusterEvent

ClusterSchedulingPolicy

ClusterSettings

Constants

Crypto

The crypto module offers a way of encapsulating secure credentials to be used as part of a secure HTTPS net or http connection.

CryptoAlgorithm

Enumerations of crypto algorighms to be used.

CryptoKeyOptions

An options type for privateEncrypt, privateDecrypt, publicEncrypt, publicDecrypt methods of Crypto.

Dgram

Datagram sockets

DiffieHellmanGroupName

Enumeration of supported group names for Crypto.getDiffieHellman.

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.

Domain

Domains provide a way to handle multiple different IO operations as a single group.

Endianness

Events

Much of the Node.js core API is built around an idiomatic asynchronous event-driven architecture in which certain kinds of objects (called "emitters") emit named events that cause Function objects ("listeners") to be called.

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

Defaults: { flags: 'r', encoding: null, fd: null, mode: 0666, autoClose: true }

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.

ListeningEventAddress

Structure emitted by 'listening' event.

ListeningEventAddressType

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.

Net

The net module provides you with an asynchronous network wrapper. It contains methods for creating both servers and clients (called streams).

NetConnectOptionsTcp

Options for the Net.connect method (TCP version).

NetConnectOptionsUnix

Options for the Net.connect method (Local domain socket version).

NetCreateServerOptions

NetIsIPResult

Enumeration of possible values for Net.isIP return.

NetworkInterface

Objects containing information about network interface addresses.

NetworkInterfaceAddressInfo

Os

The os module provides a number of operating system-related utility methods.

OsConstants

Constants object returned by Os.constants.

OsUserInfo

Information about the currently effective user (returned by Os.userInfo method).

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.

Punycode

PunycodeUcs2

Querystring

The querystring module provides utilities for parsing and formatting URL query strings.

QuerystringParseOptions

Options used for Querystring.parse method.

QuerystringParseResult

The result type of Querystring.parse. Is a collection of either strings or array of strings.

QuerystringStringifyOptions

Options for Querystring.stringify method.

Readline

The readline module provides an interface for reading data from a Readable stream (such as process.stdin) one line at a time.

ReadlineCompleterCallback

ReadlineOptions

Options object used by Readline.createInterface.

Repl

The repl module provides a Read-Eval-Print-Loop (REPL) implementation that is available both as a standalone program or includible in other applications.

ReplOptions

Options object used by Repl.start.

Require

RequireResolve

RequireResolveOptions

Stream

Base class for all streams.

StringDecoder

The string_decoder module provides an API for decoding Buffer objects into strings in a manner that preserves encoded multi-byte UTF-8 and UTF-16 characters.

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

Tty

The tty module houses the tty.ReadStream and tty.WriteStream classes. In most cases, you will not need to use this module directly.

Url

The url module provides utilities for URL resolution and parsing.

UrlFormatOptions

UrlObject

Parsed URL objects have some or all of the following fields, depending on whether or not they exist in the URL string. Any parts that are not in the URL string will not be in the parsed object.

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.

Vm

Using this class JavaScript code can be compiled and run immediately or compiled, saved, and run later.

VmContext

Type of context objects returned by Vm.createContext.

VmRunOptions

Options object used by Vm.run* methods.

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