Object 内置对象
  1. 首页
  2. 内置对象
  3. 对象 StatsWatcher

对象 StatsWatcher

文件 Stats 观察对象

当调用 fs.watchFile(target, onchange) 成功时, 返回该类型对象

1
2
3
4
5
6
7
var fs = require("fs");
var statsWatcher = fs.watchFile(target, (curStat, prevStat) => {
    // process
    // ...

    statsWatcher.unref();
});

注意 当且仅当被观察的目标文件 target 的 mtime 属性发生变化时才会触发 onchange 回调

单纯地访问(access)目标文件 target 不会触发 onchange 回调.

如果调用 fs.watchFile(target) 时, target 表示的文件或目录还不存在, 则onchange 回调不会被调用, 一直到该 target 被创建, 该回调才会开始被调用. 如果在 watcher 工作途中, )目标文件被删除, 则后续不会再有回调产生

继承关系

%0 object object toString() toJSON() EventEmitter EventEmitter new EventEmitter() EventEmitter defaultMaxListeners on() addListener() prependListener() once() prependOnceListener() off() removeListener() removeAllListeners() setMaxListeners() getMaxListeners() listeners() listenerCount() eventNames() emit() object->EventEmitter StatsWatcher StatsWatcher onchange close() ref() unref() EventEmitter->StatsWatcher

静态属性

defaultMaxListeners

Integer, 默认全局最大监听器数

1
static Integer StatsWatcher.defaultMaxListeners;

成员属性

onchange

Function, 查询和绑定"文件改变"事件，相当于 on("change", func);

1
Function StatsWatcher.onchange;

成员函数

close

停止对目标文件路径的观察, 清除引用计数(不再 hold 进程)

1
StatsWatcher.close();

ref

增加引用计数, 告知 fibjs 只要该 watcher 还在使用就不要退出进程,

1
StatsWatcher StatsWatcher.ref();

返回结果:

  • StatsWatcher, 返回 StatsWatcher 本身

经由 fs.watchFile() 得到的 StatsWatcher 默认已调用了该方法, 即默认就会 hold 进程.

unref

减少引用计数

1
StatsWatcher StatsWatcher.unref();

返回结果:

  • StatsWatcher, 返回 StatsWatcher 本身

on

绑定一个事件处理函数到对象

1
2
Object StatsWatcher.on(String ev,
    Function func);

调用参数:

  • ev: String, 指定事件的名称
  • func: Function, 指定事件处理函数

返回结果:

  • Object, 返回事件对象本身，便于链式调用

绑定一个事件处理函数到对象

1
Object StatsWatcher.on(Object map);

调用参数:

  • map: Object, 指定事件映射关系，对象属性名称将作为事件名称，属性的值将作为事件处理函数

返回结果:

  • Object, 返回事件对象本身，便于链式调用

addListener

绑定一个事件处理函数到对象

1
2
Object StatsWatcher.addListener(String ev,
    Function func);

调用参数:

  • ev: String, 指定事件的名称
  • func: Function, 指定事件处理函数

返回结果:

  • Object, 返回事件对象本身，便于链式调用

绑定一个事件处理函数到对象

1
Object StatsWatcher.addListener(Object map);

调用参数:

  • map: Object, 指定事件映射关系，对象属性名称将作为事件名称，属性的值将作为事件处理函数

返回结果:

  • Object, 返回事件对象本身，便于链式调用

prependListener

绑定一个事件处理函数到对象起始

1
2
Object StatsWatcher.prependListener(String ev,
    Function func);

调用参数:

  • ev: String, 指定事件的名称
  • func: Function, 指定事件处理函数

返回结果:

  • Object, 返回事件对象本身，便于链式调用

绑定一个事件处理函数到对象起始

1
Object StatsWatcher.prependListener(Object map);

调用参数:

  • map: Object, 指定事件映射关系，对象属性名称将作为事件名称，属性的值将作为事件处理函数

返回结果:

  • Object, 返回事件对象本身，便于链式调用

once

绑定一个一次性事件处理函数到对象，一次性处理函数只会触发一次

1
2
Object StatsWatcher.once(String ev,
    Function func);

调用参数:

  • ev: String, 指定事件的名称
  • func: Function, 指定事件处理函数

返回结果:

  • Object, 返回事件对象本身，便于链式调用

绑定一个一次性事件处理函数到对象，一次性处理函数只会触发一次

1
Object StatsWatcher.once(Object map);

调用参数:

  • map: Object, 指定事件映射关系，对象属性名称将作为事件名称，属性的值将作为事件处理函数

返回结果:

  • Object, 返回事件对象本身，便于链式调用

prependOnceListener

绑定一个事件处理函数到对象起始

1
2
Object StatsWatcher.prependOnceListener(String ev,
    Function func);

调用参数:

  • ev: String, 指定事件的名称
  • func: Function, 指定事件处理函数

返回结果:

  • Object, 返回事件对象本身，便于链式调用

绑定一个事件处理函数到对象起始

1
Object StatsWatcher.prependOnceListener(Object map);

调用参数:

  • map: Object, 指定事件映射关系，对象属性名称将作为事件名称，属性的值将作为事件处理函数

返回结果:

  • Object, 返回事件对象本身，便于链式调用

off

从对象处理队列中取消指定函数

1
2
Object StatsWatcher.off(String ev,
    Function func);

调用参数:

  • ev: String, 指定事件的名称
  • func: Function, 指定事件处理函数

返回结果:

  • Object, 返回事件对象本身，便于链式调用

取消对象处理队列中的全部函数

1
Object StatsWatcher.off(String ev);

调用参数:

  • ev: String, 指定事件的名称

返回结果:

  • Object, 返回事件对象本身，便于链式调用

从对象处理队列中取消指定函数

1
Object StatsWatcher.off(Object map);

调用参数:

  • map: Object, 指定事件映射关系，对象属性名称作为事件名称，属性的值作为事件处理函数

返回结果:

  • Object, 返回事件对象本身，便于链式调用

removeListener

从对象处理队列中取消指定函数

1
2
Object StatsWatcher.removeListener(String ev,
    Function func);

调用参数:

  • ev: String, 指定事件的名称
  • func: Function, 指定事件处理函数

返回结果:

  • Object, 返回事件对象本身，便于链式调用

取消对象处理队列中的全部函数

1
Object StatsWatcher.removeListener(String ev);

调用参数:

  • ev: String, 指定事件的名称

返回结果:

  • Object, 返回事件对象本身，便于链式调用

从对象处理队列中取消指定函数

1
Object StatsWatcher.removeListener(Object map);

调用参数:

  • map: Object, 指定事件映射关系，对象属性名称作为事件名称，属性的值作为事件处理函数

返回结果:

  • Object, 返回事件对象本身，便于链式调用

removeAllListeners

从对象处理队列中取消所有事件的所有监听器， 如果指定事件，则移除指定事件的所有监听器。

1
Object StatsWatcher.removeAllListeners(String ev);

调用参数:

  • ev: String, 指定事件的名称

返回结果:

  • Object, 返回事件对象本身，便于链式调用

从对象处理队列中取消所有事件的所有监听器， 如果指定事件，则移除指定事件的所有监听器。

1
Object StatsWatcher.removeAllListeners(Array evs = []);

调用参数:

  • evs: Array, 指定事件的名称

返回结果:

  • Object, 返回事件对象本身，便于链式调用

setMaxListeners

监听器的默认限制的数量，仅用于兼容

1
StatsWatcher.setMaxListeners(Integer n);

调用参数:

  • n: Integer, 指定事件的数量

getMaxListeners

获取监听器的默认限制的数量，仅用于兼容

1
Integer StatsWatcher.getMaxListeners();

返回结果:

  • Integer, 返回默认限制数量

listeners

查询对象指定事件的监听器数组

1
Array StatsWatcher.listeners(String ev);

调用参数:

  • ev: String, 指定事件的名称

返回结果:

  • Array, 返回指定事件的监听器数组

listenerCount

查询对象指定事件的监听器数量

1
Integer StatsWatcher.listenerCount(String ev);

调用参数:

  • ev: String, 指定事件的名称

返回结果:

  • Integer, 返回指定事件的监听器数量

查询对象指定事件的监听器数量

1
2
Integer StatsWatcher.listenerCount(Value o,
    String ev);

调用参数:

  • o: Value, 指定查询的对象
  • ev: String, 指定事件的名称

返回结果:

  • Integer, 返回指定事件的监听器数量

eventNames

查询监听器事件名称

1
Array StatsWatcher.eventNames();

返回结果:

  • Array, 返回事件名称数组

emit

主动触发一个事件

1
2
Boolean StatsWatcher.emit(String ev,
    ...args);

调用参数:

  • ev: String, 事件名称
  • args: ..., 事件参数，将会传递给事件处理函数

返回结果:

  • Boolean, 返回事件触发状态，有响应事件返回 true，否则返回 false

toString

返回对象的字符串表示，一般返回 "[Native Object]"，对象可以根据自己的特性重新实现

1
String StatsWatcher.toString();

返回结果:

  • String, 返回对象的字符串表示

toJSON

返回对象的 JSON 格式表示，一般返回对象定义的可读属性集合

1
Value StatsWatcher.toJSON(String key = "");

调用参数:

  • key: String, 未使用

返回结果:

  • Value, 返回包含可 JSON 序列化的值
© Copyright 2012-2024 fibjs.org | 支持我们