global

全局对象,所有脚本均可以访问的基础对象

Field Summary

Type Method and Description
void public static static BufferBufferBuffer

二进制数据缓存对象,用于 io 读写的数据处理,参见 Buffer 对象。

void public static static Int64Int64Int64

64位整数对象,参见 Int64 对象。

void public static static consoleconsoleconsole

控制台访问对象

void public static static processprocessprocess

控制台访问对象

readonly Worker public static readonly Worker MasterMasterMaster

Worker 宿主对象,仅在 Worker 入口脚本有效

readonly Object public static readonly Object globalglobalglobal

全局对象

readonly Array public static readonly Array argvargvargv

获取当前脚本的运行参数,启动 js 获取进程启动参数,run 执行的脚本获取传递的参数

readonly String public static readonly String __filename__filename__filename

当前脚本文件名

readonly String public static readonly String __dirname__dirname__dirname

当前脚本所在目录

Method Summary

Type Method and Description
void run(String fname,Array argv)

运行一个脚本

void clearInterval(Timer t)

清除指定的定时器

void clearTimeout(Timer t)

清除指定的定时器

void clearImmediate(Timer t)

清除指定的定时器

Timer setInterval(Function callback,Integer timeout)

每间隔指定的时间后调用函数

Timer setTimeout(Function callback,Integer timeout)

在指定的时间后调用函数

Timer setImmediate(Function callback)

下一个空闲时间立即执行回调函数

Value require(String id)

加载一个模块并返回模块对象,更多信息参阅 模块管理

void GC()

强制要求进行垃圾回收

Function sync(Function func)

包裹 callback 方法为同步调用

void repl(Array cmds)

进入交互模式,可以交互执行内部命令和代码,仅在启动 js 可以引用

void repl(Stream out,Array cmds)

进入交互模式,可以交互执行内部命令和代码,仅在启动 js 可以引用

Field Detail

Buffer

void public static static BufferBufferBuffer

二进制数据缓存对象,用于 io 读写的数据处理,参见 Buffer 对象。

Int64

void public static static Int64Int64Int64

64位整数对象,参见 Int64 对象。

console

void public static static consoleconsoleconsole

控制台访问对象

process

void public static static processprocessprocess

控制台访问对象

Master

readonly Worker public static readonly Worker MasterMasterMaster

Worker 宿主对象,仅在 Worker 入口脚本有效

global

readonly Object public static readonly Object globalglobalglobal

全局对象

argv

readonly Array public static readonly Array argvargvargv

获取当前脚本的运行参数,启动 js 获取进程启动参数,run 执行的脚本获取传递的参数

__filename

readonly String public static readonly String __filename__filename__filename

当前脚本文件名

__dirname

readonly String public static readonly String __dirname__dirname__dirname

当前脚本所在目录

Method Detail

run

void run(String fname,Array argv)

运行一个脚本

Parameters

  • fname 指定要运行的脚本路径

  • argv 指定要运行的参数,此参数可在脚本内使用 argv 获取

clearInterval

void clearInterval(Timer t)

清除指定的定时器

Parameters

  • t 指定要清除的定时器
clearTimeout

void clearTimeout(Timer t)

清除指定的定时器

Parameters

  • t 指定要清除的定时器
clearImmediate

void clearImmediate(Timer t)

清除指定的定时器

Parameters

  • t 指定要清除的定时器
setInterval

Timer setInterval(Function callback,Integer timeout)

每间隔指定的时间后调用函数

Parameters

  • callback 指定回调函数

  • timeout 指定间隔的时间,以毫秒为单位

Returns

返回定时器对象

setTimeout

Timer setTimeout(Function callback,Integer timeout)

在指定的时间后调用函数

Parameters

  • callback 指定回调函数

  • timeout 指定延时的时间,以毫秒为单位

Returns

返回定时器对象

setImmediate

Timer setImmediate(Function callback)

下一个空闲时间立即执行回调函数

Parameters

  • callback 指定回调函数

Returns

返回定时器对象

require

Value require(String id)

加载一个模块并返回模块对象,更多信息参阅 模块管理

require 可用于加载基础模块,文件模块。

基础模块是沙箱创建时初始化的模块,引用时只需传递相应的 id,比如 require(“net”)。

文件模块是用户自定义模块,引用时需传递以 ./ 或 ../ 开头的相对路径。文件模块支持 .js 和 .json 文件。

文件模块也支持 package.json 格式,当模块为目录结构时,require 会先查询 package.json 中的 main,未发现则尝试加载路径下的 index.js 或 index.json。

若引用路径不是 ./ 或 ../ 开头,并且非基础模块,require 则先在启动路径查找,然后从当前模块所在路径下的 .modules 查找,并上级目录递归。

Parameters

  • id 指定要加载的模块名称

Returns

返回加载模块的引出对象

GC

void GC()

强制要求进行垃圾回收

sync

Function sync(Function func)

包裹 callback 方法为同步调用

Parameters

  • func 给定需要包裹的方法

Returns

返回同步运行的方法

repl

void repl(Array cmds)

进入交互模式,可以交互执行内部命令和代码,仅在启动 js 可以引用

Parameters

  • cmds 补充命令,格式如下: js [ { cmd: ".test", help: "this is a test", exec: function(argv) { console.log(argv); } }, { cmd: ".test1", help: "this is an other test", exec: function(argv) { console.log(argv); } } ]
repl

void repl(Stream out,Array cmds)

进入交互模式,可以交互执行内部命令和代码,仅在启动 js 可以引用

同一时刻只允许一个 Stream repl,新建一个 Stream repl 时,前一个 repl 将被关闭。

Parameters

  • out 输入输出流对象,通常为网络连接

  • cmds 补充命令,格式如下:

    [
    {
        cmd: ".test",
        help: "this is a test",
        exec: function(argv) {
            console.log(argv);
        }
    },
    {
        cmd: ".test1",
        help: "this is an other test",
        exec: function(argv) {
            console.log(argv);
        }
    }
    ]