分类标签归档:Node.js

Node.js api 中文文档 - Zlib


稳定度: 2 - 稳定

要获取这个模块,你可以通过:

var zlib = require('zlib');

它提供了Gzip/GunzipDeflate/InflateDeflateRaw/InflateRaw类的绑定。每个类都有相同的选项,并且都是可读/可写流。

例子

可以通过将一个fs.ReadStream的数据导入一个zlib流,然后导入一个fs.WriteStream,来压缩或解压缩一个文件。

var gzip = zlib.createGzip();
var fs = require('fs');
var inp = fs.createR...

阅读全文...

Node.js api 中文文档 - 执行`JavaScript`


稳定度: 2 - 稳定

要获取这个模块,你可以通过:

var vm = require('vm');

JavaScript代码会被编译且立刻执行 或 编译,保存,并且稍后执行。

vm.runInThisContext(code[, options])

vm.runInThisContext()编译代码,运行它,然后返回结果。运行中的代码不能访问本地作用域,但是可以访问当前的全局对象。

使用vm.runInThisContexteval运行相同代码的例子:

var vm = require('vm');
var localVar = 'initi...

阅读全文...

Node.js api 中文文档 - V8


稳定度: 2 - 稳定

这个模块暴露了node.js内建的指定版本的V8的事件和接口。这些接口受上游(upstream)变化的影响,所以没有被稳定索引(stability index)所覆盖。

getHeapStatistics()

返回一个包含以下属性的对象。

{
  total_heap_size: 7326976,
  total_heap_size_executable: 4194304,
  total_physical_size: 7326976,
  used_heap_size: 3476208,
  heap_size_limit: 1535115264
}

setF...

阅读全文...

Node.js api 中文文档 - util


稳定度: 2 - 稳定

这些功能在模块'util'中,通过require('util')来使用它们。

util模块主要的设计意图是满足node.js内部API的需要。但是许多工具对于你的程序也十分有用。如果你发现这些功能不能满足你的需要,那么鼓励你编写自己的工具集。我们对任何node.js内部功能不需要的功能,都不感兴趣。

util.callbackify(original)

于v8.2.0加入

  • original async函数
  • Returns: 回调函数

参数接收一个async函数(或者函数返回值是promise), 返回一个Node.js错误优先的回调函数, 第一个参数是错...

阅读全文...

Node.js api 中文文档 - URL


稳定度: 2 - 稳定

这个模块提供了URL解析和解释的工具。通过require('url')使用它。

解释URL为一个含有以下部分或全部属性的对象,依赖于它们是否在URL字符串中存在。任何不存在的部分都不会出现在解释后的对象中。一个下面URL的例子:

'http://user:pass@host.com:8080/p/a/t/h?query=string#hash'

  • href: 最初传递的全部URL。协议和主机都是小写的。

例子: 'http://user:pass@host.com:8080/p/a/t/h?query=string#hash'

  • protocol: 请求的协议,...

阅读全文...

Node.js api 中文文档 - UDP / Datagram Sockets


稳定度: 2 - 稳定

数据报socket通过require('dgram')使用。

重要提示:dgram.Socket#bind()的表现在v0.10中被改变,并且现在总是异步的,如果你有像这样的代码:

var s = dgram.createSocket('udp4');
s.bind(1234);
s.addMembership('224.0.0.114');

你必须改成这样:

var s = dgram.createSocket('udp4');
s.bind(1234, function() {
  s.addMembershi...

阅读全文...

Node.js api 中文文档 - TTY


Stability: 2 - Stable

tty模块主要提供了tty.ReadStreamtty.WriteStream这两个类。大多数情况下,你都不需要直接使用这个模块。

node.js检测到它运行于TTY上下文中,那么process.stdin将会是一个tty.ReadStream实例,process.stdout将会是一个tty.WriteStream实例。测试node.js是否运行在TTY上下文中的一个比较好的办法是检查process.stdout.isTTY

$ iojs -p -e "Boolean(process.stdout.isTTY)"
t...

阅读全文...

Node.js api 中文文档 - TLS (SSL)


稳定度: 2 - 稳定

通过require('tls')来使用这个模块。

tls模块使用OpenSSL来提供传输层的安全 和/或 安全socket层:已加密的流通信。

TLS/SSL是一种公/私钥架构。每个客户端和每个服务器都必须有一个私钥。一个私钥通过像如下的方式创建:

openssl genrsa -out ryans-key.pem 2048

所有的服务器和部分的客户端需要一个证书。证书是被CA签名或自签名的公钥。获取一个证书第一步是创建一个“证书签署请求(Certificate Signing Request)”(CSR)文件。通过:

openssl req -new -sha...

阅读全文...

Node.js api 中文文档 - Timers


稳定度: 3 - 锁定

所有的定时器函数都是全局的。当需要使用它们时,不必通过require()

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

在指定的延时(毫秒)后执行一次回调函数。返回一个可以被调用clearTimeout()timeoutObject。可选的,你可以传递回调函数的参数。

需要注意的是,你的回调函数可以不会在精确的在指定的毫秒延时后执行 - node.js对回调函数执行的精确时间以及顺序都不作保证。回调函数的执行点会尽量接近指定的延时。

clearTimeout(timeoutObject)

阻止一个timeout的触发。

s...

阅读全文...

Node.js api 中文文档 - Stream


稳定度: 2 - 稳定

流是一个被node.js内部的许多对象所实现的抽象接口。例如一个发往HTTP服务器的请求是一个留,stdout也是一个流。流可以是可读的,可写的或双向的。所有的流都是EventEmitter实例。

你可以通过require('stream')来取货Stream的基类。其中包括了Readable流,Writable流,Duplex流和Transform流的基类。

此文档分为三个章节。第一章节解释了在你的编程中使用流时需要的API。如果你不需要实现你自己的流式API,你可以在这里停止。

第二章节解释了你在构建你自己的流时需要的API,这些API是为了方便你这么做而设计...

阅读全文...