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 |支持我們