Node.js v0.12 API英文文档PDF：全面指南与核心模块详解

需积分: 10 59 浏览量更新于2024-07-21 收藏 4.03MB PDF 举报

Node.js v0.12 API文档是针对这个特定版本的JavaScript运行环境（Node.js）的一份详尽指南，它在2015年8月13日发布，对应的是v0.12.7。这份文档主要包含以下几个关键部分： 1. **关于文档**： - 提供了文档的整体介绍，说明其是Node.js v0.12的一个官方手册和参考文档。 - 提供了链接（<https://nodejs.org/api/all.html>），用户可以从这里访问完整的API文档。 2. **内容结构**： - 文档分为多个章节，如教程（Tutorials）、贡献指南（CONTRIBUTING）、工作流程（WORKFLOW）和本地化支持（LOCALIZATION）等，展示了文档的全面性。 - 主要聚焦于API文档，包括全局对象、模块管理、定时器、循环机制和核心模块等内容。 3. **核心概念与功能**： - **全局对象**：如`global`、`process`、`console`等，这些对象在Node.js环境中具有特殊作用，如处理程序上下文、控制台输出、缓冲区操作等。 - **Buffer类**：Node.js中的二进制数据结构，用于处理非字符串数据，如文件I/O和网络通信。 - **require()函数**：用于加载模块，提供模块查找、缓存管理等功能。 - **定时器**：`setTimeout`、`clearTimeout`、`setInterval`和`clearInterval`等，用于异步执行代码或定期执行任务。 - **控制台操作**：`console.log`、`console.info`、`console.error`等，用于输出不同级别的日志信息。 - **模块管理**：包括模块的名称解析、缓存管理和扩展点`require.extensions`。 - **模块生命周期**：如`__filename`和`__dirname`，用于获取当前模块的文件路径和目录。 - **导出与导入**：`module`、`exports`是模块系统的核心，用于导出模块定义的功能和变量供其他模块使用。 - **计时器管理**：`unref`和`ref`用于控制回调是否阻塞事件循环，`setImmediate`和`clearImmediate`用于立即执行回调。 4. **稳定性指数**： - 文档可能包含每个API的稳定性评级，有助于开发者了解哪些功能更适合长期依赖。 Node.js v0.12 API文档是开发者深入理解并利用Node.js框架进行开发的重要资源，涵盖了基础语法、模块系统、I/O操作以及异步编程的关键要素。阅读这份文档，可以帮助开发者编写高效、稳定的Node.js应用。

2015/8/13 About this Documentation Node.js v0.12.7 Manual & Documentation

https://nodejs.org/api/all.html 16/212

Every HTML file in the markdown has a corresponding JSON file with the same data.

This feature is new as of node v0.6.12. It is experimental.

Synopsis

An example of a web server written with Node which responds with 'Hello World':

var http = require('http');

http.createServer(function (request, response) {

response.writeHead(200, {'Content-Type': 'text/plain'});

response.end('Hello World\n');

}).listen(8124);

console.log('Server running at http://127.0.0.1:8124/');

To run the server, put the code into a file called example.js and execute it with the node program

> node example.js

Server running at http://127.0.0.1:8124/

All of the examples in the documentation can be run similarly.

Global Objects

These objects are available in all modules. Some of these objects aren't actually in the global scope

but in the module scope - this will be noted.

global

{Object} The global namespace object.

In browsers, the top-level scope is the global scope. That means that in browsers if you're in the global scope var something

will define a global variable. In Node this is different. The top-level scope is not the global scope; var something inside a Node

module will be local to that module.

process

{Object}

The process object. See the process object section.

console

{Object}

Used to print to stdout and stderr. See the console section.

Class: Buffer

{Function}

Used to handle binary data. See the buffer section

require()

{Function}

To require modules. See the Modules section. require isn't actually a global but rather local to each module.

2015/8/13 About this Documentation Node.js v0.12.7 Manual & Documentation

https://nodejs.org/api/all.html 18/212

See the module system documentation for more information.

exports

A reference to the module.exports that is shorter to type. See module system documentation for details on when to use

exports and when to use module.exports.

exports isn't actually a global but rather local to each module.

See the module system documentation for more information.

See the module section for more information.

setTimeout(cb, ms)

Run callback cb after

at least

ms milliseconds. The actual delay depends on external factors like OS timer granularity and system

load.

The timeout must be in the range of 1-2,147,483,647 inclusive. If the value is outside that range, it's changed to 1 millisecond.

Broadly speaking, a timer cannot span more than 24.8 days.

Returns an opaque value that represents the timer.

clearTimeout(t)

Stop a timer that was previously created with setTimeout(). The callback will not execute.

setInterval(cb, ms)

Run callback cb repeatedly every ms milliseconds. Note that the actual interval may vary, depending on external factors like OS

timer granularity and system load. It's never less than ms but it may be longer.

The interval must be in the range of 1-2,147,483,647 inclusive. If the value is outside that range, it's changed to 1 millisecond.

Broadly speaking, a timer cannot span more than 24.8 days.

Returns an opaque value that represents the timer.

clearInterval(t)

Stop a timer that was previously created with setInterval(). The callback will not execute.

The timer functions are global variables. See the timers section.

console

Stability: 4 - API Frozen

Object

For printing to stdout and stderr. Similar to the console object functions provided by most web browsers, here the output is sent

to stdout or stderr.

The console functions are synchronous when the destination is a terminal or a file (to avoid lost messages in case of premature

exit) and asynchronous when it's a pipe (to avoid blocking for long periods of time).

That is, in the following example, stdout is non-blocking while stderr is blocking:

$ node script.js 2> error.log | tee info.log

In daily use, the blocking/non-blocking dichotomy is not something you should worry about unless you log huge amounts of

data.

console.log([data][, ...])

Prints to stdout with newline. This function can take multiple arguments in a printf()-like way. Example:

2015/8/13 About this Documentation Node.js v0.12.7 Manual & Documentation

https://nodejs.org/api/all.html 20/212

setTimeout(callback, delay[, arg][, ...])

To schedule execution of a one-time callback after delay milliseconds. Returns a timeoutObject for possible use with

clearTimeout(). Optionally you can also pass arguments to the callback.

It is important to note that your callback will probably not be called in exactly delay milliseconds - Node.js makes no

guarantees about the exact timing of when the callback will fire, nor of the ordering things will fire in. The callback will be called

as close as possible to the time specified.

clearTimeout(timeoutObject)

Prevents a timeout from triggering.

setInterval(callback, delay[, arg][, ...])

To schedule the repeated execution of callback every delay milliseconds. Returns a intervalObject for possible use with

clearInterval(). Optionally you can also pass arguments to the callback.

clearInterval(intervalObject)

Stops an interval from triggering.

unref()

The opaque value returned by setTimeout and setInterval also has the method timer.unref() which will allow you to

create a timer that is active but if it is the only item left in the event loop won't keep the program running. If the timer is already

unrefd calling unref again will have no effect.

In the case of setTimeout when you unref you create a separate timer that will wakeup the event loop, creating too many of

these may adversely effect event loop performance -- use wisely.

ref()

If you had previously unref()d a timer you can call ref() to explicitly request the timer hold the program open. If the timer is

already refd calling ref again will have no effect.

setImmediate(callback[, arg][, ...])

To schedule the "immediate" execution of callback after I/O events callbacks and before setTimeout and setInterval .

Returns an immediateObject for possible use with clearImmediate(). Optionally you can also pass arguments to the

callback.

Callbacks for immediates are queued in the order in which they were created. The entire callback queue is processed every event

loop iteration. If you queue an immediate from inside an executing callback, that immediate won't fire until the next event loop

iteration.

clearImmediate(immediateObject)

Stops an immediate from triggering.

Modules

Stability: 5 - Locked

Node has a simple module loading system. In Node, files and modules are in one-to-one correspondence. As an example,

foo.js loads the module circle.js in the same directory.

The contents of foo.js:

var circle = require('./circle.js');

console.log( 'The area of a circle of radius 4 is '

+ circle.area(4));

The contents of circle.js:

剩余211页未读，继续阅读

jcs12311

粉丝: 4
资源: 6

Node.js v0.12 API英文文档PDF：全面指南与核心模块详解

NodeJS开发REST API的完整代码库指南

重构NodeJS Asterisk Manager API实现低级接口控制

NodeJS集成Whispir API实现多渠道通信功能

nodejs.chm API文档 英文

nodejs:的NodeJS 0.12

nodejs 文档(nodejs最好的api框架)-.pdf

NodeJS API文档

NodeJS基础API文档.zip

nodejs windows安装配置文档.pdf

Nodejs-Express框架API文档及Jade文档

最新资源

nodejs.chm API文档英文