オブジェクト FSWatcher
ファイル システム ウォッチ オブジェクト
呼び出しfs.watch(target)
が成功する、この型のオブジェクトが返されます
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19var fs = require("fs");
var watcher = fs.watch((eventType, filename) => {
if (filename) {
console.log(filename);
// Prints: <Buffer ...>
}
});
watcher.close();
// calling fs.watch with callback and options
fs.watch('./tmp', {
encoding: 'buffer'
}, (eventType, filename) => {
if (filename) {
console.log(filename);
// Prints: <Buffer ...>
}
});
相続関係
静的プロパティ
defaultMaxListeners
整数、リスナーのデフォルトのグローバル最大数
1static Integer FSWatcher.defaultMaxListeners;
メンバー属性
onchange
関数、クエリ、バインドの「ファイル変更」イベント。on("change", func) と同等。
1Function FSWatcher.onchange;
onclose
on("close", func); と同等の "watcher closed" イベントを関数化し、クエリし、バインドします。
1Function FSWatcher.onclose;
onerror
on("error", func); と同等の「エラーが発生しました」イベントを関数、クエリ、およびバインドします。
1Function FSWatcher.onerror;
メンバー関数
close
ウォッチャーを閉じて、対応するファイル変更処理イベントを受信しなくなります
1FSWatcher.close();
on
イベント ハンドラーをオブジェクトにバインドする
1
2Object FSWatcher.on(String ev,
Function func);
呼び出しパラメーター:
- ev: 文字列、指定されたイベントの名前
- func: 関数、イベント ハンドラ関数を指定します。
戻り値:
- Object、チェーン呼び出しに便利なイベントオブジェクト自体を返します
イベント ハンドラーをオブジェクトにバインドする
1Object FSWatcher.on(Object map);
呼び出しパラメーター:
- map: オブジェクト、イベント マッピング関係を指定します。オブジェクト属性名はイベント名として使用され、属性値はイベント処理関数として使用されます。
戻り値:
- Object、チェーン呼び出しに便利なイベントオブジェクト自体を返します
addListener
イベント ハンドラーをオブジェクトにバインドする
1
2Object FSWatcher.addListener(String ev,
Function func);
呼び出しパラメーター:
- ev: 文字列、指定されたイベントの名前
- func: 関数、イベント ハンドラ関数を指定します。
戻り値:
- Object、チェーン呼び出しに便利なイベントオブジェクト自体を返します
イベント ハンドラーをオブジェクトにバインドする
1Object FSWatcher.addListener(Object map);
呼び出しパラメーター:
- map: オブジェクト、イベント マッピング関係を指定します。オブジェクト属性名はイベント名として使用され、属性値はイベント処理関数として使用されます。
戻り値:
- Object、チェーン呼び出しに便利なイベントオブジェクト自体を返します
prependListener
イベント ハンドラー関数をオブジェクト start にバインドする
1
2Object FSWatcher.prependListener(String ev,
Function func);
呼び出しパラメーター:
- ev: 文字列、指定されたイベントの名前
- func: 関数、イベント ハンドラ関数を指定します。
戻り値:
- Object、チェーン呼び出しに便利なイベントオブジェクト自体を返します
イベント ハンドラー関数をオブジェクト start にバインドする
1Object FSWatcher.prependListener(Object map);
呼び出しパラメーター:
- map: オブジェクト、イベント マッピング関係を指定します。オブジェクト属性名はイベント名として使用され、属性値はイベント処理関数として使用されます。
戻り値:
- Object、チェーン呼び出しに便利なイベントオブジェクト自体を返します
once
ワンタイム イベント ハンドラーをオブジェクトにバインドします。ワンタイム ハンドラーは 1 回だけトリガーされます。
1
2Object FSWatcher.once(String ev,
Function func);
呼び出しパラメーター:
- ev: 文字列、指定されたイベントの名前
- func: 関数、イベント ハンドラ関数を指定します。
戻り値:
- Object、チェーン呼び出しに便利なイベントオブジェクト自体を返します
ワンタイム イベント ハンドラーをオブジェクトにバインドします。ワンタイム ハンドラーは 1 回だけトリガーされます。
1Object FSWatcher.once(Object map);
呼び出しパラメーター:
- map: オブジェクト、イベント マッピング関係を指定します。オブジェクト属性名はイベント名として使用され、属性値はイベント処理関数として使用されます。
戻り値:
- Object、チェーン呼び出しに便利なイベントオブジェクト自体を返します
prependOnceListener
イベント ハンドラー関数をオブジェクト start にバインドする
1
2Object FSWatcher.prependOnceListener(String ev,
Function func);
呼び出しパラメーター:
- ev: 文字列、指定されたイベントの名前
- func: 関数、イベント ハンドラ関数を指定します。
戻り値:
- Object、チェーン呼び出しに便利なイベントオブジェクト自体を返します
イベント ハンドラー関数をオブジェクト start にバインドする
1Object FSWatcher.prependOnceListener(Object map);
呼び出しパラメーター:
- map: オブジェクト、イベント マッピング関係を指定します。オブジェクト属性名はイベント名として使用され、属性値はイベント処理関数として使用されます。
戻り値:
- Object、チェーン呼び出しに便利なイベントオブジェクト自体を返します
off
オブジェクト処理キューから関数を指定解除
1
2Object FSWatcher.off(String ev,
Function func);
呼び出しパラメーター:
- ev: 文字列、指定されたイベントの名前
- func: 関数、イベント ハンドラ関数を指定します。
戻り値:
- Object、チェーン呼び出しに便利なイベントオブジェクト自体を返します
オブジェクト処理キュー内のすべての機能をキャンセルします
1Object FSWatcher.off(String ev);
呼び出しパラメーター:
- ev: 文字列、指定されたイベントの名前
戻り値:
- Object、チェーン呼び出しに便利なイベントオブジェクト自体を返します
オブジェクト処理キューから関数を指定解除
1Object FSWatcher.off(Object map);
呼び出しパラメーター:
- map: オブジェクト、イベント マッピング関係を指定します。オブジェクト属性の名前はイベント名として使用され、属性の値はイベント処理関数として使用されます。
戻り値:
- Object、チェーン呼び出しに便利なイベントオブジェクト自体を返します
removeListener
オブジェクト処理キューから関数を指定解除
1
2Object FSWatcher.removeListener(String ev,
Function func);
呼び出しパラメーター:
- ev: 文字列、指定されたイベントの名前
- func: 関数、イベント ハンドラ関数を指定します。
戻り値:
- Object、チェーン呼び出しに便利なイベントオブジェクト自体を返します
オブジェクト処理キュー内のすべての機能をキャンセルします
1Object FSWatcher.removeListener(String ev);
呼び出しパラメーター:
- ev: 文字列、指定されたイベントの名前
戻り値:
- Object、チェーン呼び出しに便利なイベントオブジェクト自体を返します
オブジェクト処理キューから関数を指定解除
1Object FSWatcher.removeListener(Object map);
呼び出しパラメーター:
- map: オブジェクト、イベント マッピング関係を指定します。オブジェクト属性の名前はイベント名として使用され、属性の値はイベント処理関数として使用されます。
戻り値:
- Object、チェーン呼び出しに便利なイベントオブジェクト自体を返します
removeAllListeners
オブジェクト処理キューからすべてのイベントのすべてのリスナーをキャンセルするか、イベントが指定されている場合は、指定されたイベントのすべてのリスナーを削除します。
1Object FSWatcher.removeAllListeners(String ev);
呼び出しパラメーター:
- ev: 文字列、指定されたイベントの名前
戻り値:
- Object、チェーン呼び出しに便利なイベントオブジェクト自体を返します
オブジェクト処理キューからすべてのイベントのすべてのリスナーをキャンセルするか、イベントが指定されている場合は、指定されたイベントのすべてのリスナーを削除します。
1Object FSWatcher.removeAllListeners(Array evs = []);
呼び出しパラメーター:
- evs: 配列、指定されたイベントの名前
戻り値:
- Object、チェーン呼び出しに便利なイベントオブジェクト自体を返します
setMaxListeners
互換性のみを目的とした、リスナー数のデフォルトの制限
1FSWatcher.setMaxListeners(Integer n);
呼び出しパラメーター:
- n: 整数、イベントの数を指定します
getMaxListeners
互換性のみを目的として、デフォルトの制限された数のリスナーを取得します
1Integer FSWatcher.getMaxListeners();
戻り値:
- Integer、デフォルトの制限数を返します
listeners
オブジェクトの指定されたイベントのリスナーの配列を照会します
1Array FSWatcher.listeners(String ev);
呼び出しパラメーター:
- ev: 文字列、指定されたイベントの名前
戻り値:
- Array、指定されたイベントのリスナーの配列を返します
listenerCount
オブジェクトの指定されたイベントのリスナーの数を照会します
1Integer FSWatcher.listenerCount(String ev);
呼び出しパラメーター:
- ev: 文字列、指定されたイベントの名前
戻り値:
- Integer、指定されたイベントのリスナーの数を返します
オブジェクトの指定されたイベントのリスナーの数を照会します
1
2Integer FSWatcher.listenerCount(Value o,
String ev);
呼び出しパラメーター:
- o: 値、クエリのオブジェクトを指定します
- ev: 文字列、指定されたイベントの名前
戻り値:
- Integer、指定されたイベントのリスナーの数を返します
eventNames
クエリ リスナー イベント名
1Array FSWatcher.eventNames();
戻り値:
- Array、イベント名の配列を返します
emit
イベントを積極的にトリガーする
1
2Boolean FSWatcher.emit(String ev,
...args);
呼び出しパラメーター:
- ev: 文字列、イベント名
- args: ...、イベント パラメーターは、イベント ハンドラー関数に渡されます。
戻り値:
- Boolean、イベント トリガー ステータスを返します。応答イベントがある場合は true を返し、そうでない場合は false を返します。
toString
オブジェクトの文字列表現を返します。通常は「[Native Object]」を返します。オブジェクトは独自の特性に従って再実装できます
1String FSWatcher.toString();
戻り値:
- String、オブジェクトの文字列表現を返します
toJSON
オブジェクトの JSON 形式表現を返します。通常は、オブジェクトによって定義された読み取り可能なプロパティのコレクションを返します。
1Value FSWatcher.toJSON(String key = "");
呼び出しパラメーター:
- key: 文字列、未使用
戻り値:
- Value、JSON シリアル化可能な値を返します