Node.js JavaScript runtime 🐢🚀
 
 
 
 
 
 
Go to file
Tyler Anton 51fe319faf docs: add return value for sync fs functions
Clarify that synchronous functions in fs with no return value return
undefined.

Specify that fs.openSync() returns an integer and fs.existsSync()
returns true or false.

Fixes #9313

PR: #9359
PR-URL: https://github.com/joyent/node/pull/9359
Reviewed-By: Julien Gilli <julien.gilli@joyent.com>
2015-03-10 16:33:57 -07:00
benchmark buffer: improve {read,write}{U}Int* methods 2014-06-23 16:58:55 -07:00
deps deps: update libuv to 0.10.36 2015-03-06 11:37:40 -08:00
doc docs: add return value for sync fs functions 2015-03-10 16:33:57 -07:00
lib url: revert reslove urls with . and .. 2015-03-06 12:44:06 -08:00
src Now working on 0.10.37 2015-01-26 12:28:48 -08:00
test url: revert reslove urls with . and .. 2015-03-06 12:44:06 -08:00
tools crypto: update root certificates 2014-12-04 16:57:48 +03:00
.gitattributes Explicitly disable cr/lf conversion for test fixtures 2011-08-10 19:59:37 +02:00
.gitignore src: remove icu_config 2014-12-15 15:36:00 -08:00
.mailmap Update .mailmap and AUTHORS 2013-03-19 20:07:38 +01:00
.travis.yml test: add `.travis.yml` for testing on Travis CI 2011-12-05 16:50:55 -08:00
AUTHORS 2014.12.22, Version 0.10.35 (Stable) 2014-12-22 13:22:32 -08:00
BSDmakefile Tell BSD users to run `gmake` instead. 2011-07-11 14:17:23 +02:00
CONTRIBUTING.md node: signing the CLA is no longer a requirement 2014-06-11 11:51:53 -04:00
ChangeLog 2015.01.26, Version 0.10.36 (Stable) 2015-01-26 10:28:23 -08:00
LICENSE doc: Update LICENSE for zlib 1.2.8 2014-12-16 15:35:09 -08:00
Makefile docs: update api location 2014-10-17 15:14:45 -07:00
README.md doc: link to pre-built binaries, add install note 2013-10-01 08:37:32 +02:00
common.gypi gyp: use --export-dynamic on FreeBSD 2014-08-27 00:20:10 +04:00
configure build: configure return exit status from gyp 2014-12-15 13:55:11 -08:00
node.gyp gyp: preserve v8dbg syms on freebsd too 2014-08-18 17:58:36 +04:00
vcbuild.bat build: add win32 convenience build rule 2015-01-23 15:17:05 -08:00

README.md

Evented I/O for V8 javascript. Build Status

To build:

Prerequisites (Unix only):

* GCC 4.2 or newer
* Python 2.6 or 2.7
* GNU Make 3.81 or newer
* libexecinfo (FreeBSD and OpenBSD only)

Unix/Macintosh:

./configure
make
make install

If your python binary is in a non-standard location or has a non-standard name, run the following instead:

export PYTHON=/path/to/python
$PYTHON ./configure
make
make install

Windows:

vcbuild.bat

You can download pre-built binaries for various operating systems from http://nodejs.org/download/. The Windows and OS X installers will prompt you for the location to install to. The tarballs are self-contained; you can extract them to a local directory with:

tar xzf /path/to/node-<version>-<platform>-<arch>.tar.gz

Or system-wide with:

cd /usr/local && tar --strip-components 1 -xzf \
                     /path/to/node-<version>-<platform>-<arch>.tar.gz

To run the tests:

Unix/Macintosh:

make test

Windows:

vcbuild.bat test

To build the documentation:

make doc

To read the documentation:

man doc/node.1

Resources for Newcomers