オブジェクト組み込みオブジェクト

オブジェクト FSWatcher

ファイルシステム監視対象

呼び出しfs.watch(target)が成功すると、オブジェクトの戻り型

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
var fs = require("fs"); var watcher = fs.watch((eventType, filename) => { if (filename) { console.log(filename); // Prints: <Buffer ...> } }); watcher.close(); // 带回调地调用 fs.watch('./tmp', { encoding: 'buffer' }, (eventType, filename) => { if (filename) { console.log(filename); // Prints: <Buffer ...> } });

継承

#lineWidth: 1.5 #font: Helvetica,sans-Serif #fontSize: 10 #leading: 1.6 #.this: fill=lightgray #.class: fill=white [<class>object|toString();toJSON()] [<class>EventEmitter|new EventEmitter()|EventEmitter|defaultMaxListeners|on();addListener();prependListener();once();prependOnceListener();off();removeListener();removeAllListeners();setMaxListeners();getMaxListeners();listeners();listenerCount();eventNames();emit()] [<this>FSWatcher|onchange;onclose;onerror|close()] [object] <:- [EventEmitter] [EventEmitter] <:- [FSWatcher] EventEmitter new EventEmitter() EventEmitter defaultMaxListeners on() addListener() prependListener() once() prependOnceListener() off() removeListener() removeAllListeners() setMaxListeners() getMaxListeners() listeners() listenerCount() eventNames() emit() FSWatcher onchange onclose onerror close() object toString() toJSON()

静的プロパティ

defaultMaxListeners

整数、リスナーのデフォルトのグローバル最大数

1
static Integer FSWatcher.defaultMaxListeners;

メンバーの属性

onchange

on("change", func); と同等の「ファイル変更」イベントの関数、クエリ、バインド。

1
Function FSWatcher.onchange;

onclose

on("close", func); と同等の "watcher close" イベントを関数、クエリ、バインドします。

1
Function FSWatcher.onclose;

onerror

on("error", func); と同等の「エラーが発生しました」イベントを関数、クエリ、およびバインドします。

1
Function FSWatcher.onerror;

メンバー関数

close

Watcher を閉じると、対応するファイル変更処理イベントを受信しなくなります。

1
FSWatcher.close();

on

イベントハンドラーをオブジェクトにバインドする

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

呼び出しパラメータ:

  • ev: 文字列、イベントの名前を指定
  • func:関数、イベント処理関数を指定

結果を返す:

  • Object, 連鎖呼び出しに便利なイベントオブジェクト自体を返す

イベントハンドラーをオブジェクトにバインドする

1
Object FSWatcher.on(Object map);

呼び出しパラメータ:

  • map: オブジェクト、イベント マッピング関係を指定します。オブジェクト プロパティ名はイベント名として使用され、プロパティ値はイベント処理関数として使用されます

結果を返す:

  • Object, 連鎖呼び出しに便利なイベントオブジェクト自体を返す

addListener

イベントハンドラーをオブジェクトにバインドする

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

呼び出しパラメータ:

  • ev: 文字列、イベントの名前を指定
  • func:関数、イベント処理関数を指定

結果を返す:

  • Object, 連鎖呼び出しに便利なイベントオブジェクト自体を返す

イベントハンドラーをオブジェクトにバインドする

1
Object FSWatcher.addListener(Object map);

呼び出しパラメータ:

  • map: オブジェクト、イベント マッピング関係を指定します。オブジェクト プロパティ名はイベント名として使用され、プロパティ値はイベント処理関数として使用されます

結果を返す:

  • Object, 連鎖呼び出しに便利なイベントオブジェクト自体を返す

prependListener

イベント ハンドラーをオブジェクトの先頭にバインドします。

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

呼び出しパラメータ:

  • ev: 文字列、イベントの名前を指定
  • func:関数、イベント処理関数を指定

結果を返す:

  • Object, 連鎖呼び出しに便利なイベントオブジェクト自体を返す

イベント ハンドラーをオブジェクトの先頭にバインドします。

1
Object FSWatcher.prependListener(Object map);

呼び出しパラメータ:

  • map: オブジェクト、イベント マッピング関係を指定します。オブジェクト プロパティ名はイベント名として使用され、プロパティ値はイベント処理関数として使用されます

結果を返す:

  • Object, 連鎖呼び出しに便利なイベントオブジェクト自体を返す

once

1 回限りのイベント処理関数をオブジェクトにバインドします。1 回限りの処理関数は 1 回だけトリガーされます。

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

呼び出しパラメータ:

  • ev: 文字列、イベントの名前を指定
  • func:関数、イベント処理関数を指定

結果を返す:

  • Object, 連鎖呼び出しに便利なイベントオブジェクト自体を返す

1 回限りのイベント処理関数をオブジェクトにバインドします。1 回限りの処理関数は 1 回だけトリガーされます。

1
Object FSWatcher.once(Object map);

呼び出しパラメータ:

  • map: オブジェクト、イベント マッピング関係を指定します。オブジェクト プロパティ名はイベント名として使用され、プロパティ値はイベント処理関数として使用されます

結果を返す:

  • Object, 連鎖呼び出しに便利なイベントオブジェクト自体を返す

prependOnceListener

イベント ハンドラーをオブジェクトの先頭にバインドします。

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

呼び出しパラメータ:

  • ev: 文字列、イベントの名前を指定
  • func:関数、イベント処理関数を指定

結果を返す:

  • Object, 連鎖呼び出しに便利なイベントオブジェクト自体を返す

イベント ハンドラーをオブジェクトの先頭にバインドします。

1
Object FSWatcher.prependOnceListener(Object map);

呼び出しパラメータ:

  • map: オブジェクト、イベント マッピング関係を指定します。オブジェクト プロパティ名はイベント名として使用され、プロパティ値はイベント処理関数として使用されます

結果を返す:

  • Object, 連鎖呼び出しに便利なイベントオブジェクト自体を返す

off

指定された関数をオブジェクト処理キューからキャンセルします

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

呼び出しパラメータ:

  • ev: 文字列、イベントの名前を指定
  • func:関数、イベント処理関数を指定

結果を返す:

  • Object, 連鎖呼び出しに便利なイベントオブジェクト自体を返す

オブジェクト処理キュー内のすべての機能をキャンセルします

1
Object FSWatcher.off(String ev);

呼び出しパラメータ:

  • ev: 文字列、イベントの名前を指定

結果を返す:

  • Object, 連鎖呼び出しに便利なイベントオブジェクト自体を返す

指定された関数をオブジェクト処理キューからキャンセルします

1
Object FSWatcher.off(Object map);

呼び出しパラメータ:

  • map: オブジェクト、イベント マッピング関係を指定します。オブジェクト プロパティ名はイベント名として使用され、プロパティ値はイベント処理関数として使用されます

結果を返す:

  • Object, 連鎖呼び出しに便利なイベントオブジェクト自体を返す

removeListener

指定された関数をオブジェクト処理キューからキャンセルします

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

呼び出しパラメータ:

  • ev: 文字列、イベントの名前を指定
  • func:関数、イベント処理関数を指定

結果を返す:

  • Object, 連鎖呼び出しに便利なイベントオブジェクト自体を返す

オブジェクト処理キュー内のすべての機能をキャンセルします

1
Object FSWatcher.removeListener(String ev);

呼び出しパラメータ:

  • ev: 文字列、イベントの名前を指定

結果を返す:

  • Object, 連鎖呼び出しに便利なイベントオブジェクト自体を返す

指定された関数をオブジェクト処理キューからキャンセルします

1
Object FSWatcher.removeListener(Object map);

呼び出しパラメータ:

  • map: オブジェクト、イベント マッピング関係を指定します。オブジェクト プロパティ名はイベント名として使用され、プロパティ値はイベント処理関数として使用されます

結果を返す:

  • Object, 連鎖呼び出しに便利なイベントオブジェクト自体を返す

removeAllListeners

オブジェクト処理キューから全イベントの全リスナーを解除 イベントを指定している場合は、指定したイベントの全リスナーを削除します。

1
Object FSWatcher.removeAllListeners(String ev);

呼び出しパラメータ:

  • ev: 文字列、イベントの名前を指定

結果を返す:

  • Object, 連鎖呼び出しに便利なイベントオブジェクト自体を返す

オブジェクト処理キューから全イベントの全リスナーを解除 イベントを指定している場合は、指定したイベントの全リスナーを削除します。

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

呼び出しパラメータ:

  • evs: 配列、イベントの名前を指定します

結果を返す:

  • Object, 連鎖呼び出しに便利なイベントオブジェクト自体を返す

setMaxListeners

互換性のためだけのリスナー数のデフォルト制限

1
FSWatcher.setMaxListeners(Integer n);

呼び出しパラメータ:

  • n: 整数、イベント数を指定

getMaxListeners

互換性のためだけに、リスナーの数のデフォルトの制限を取得します

1
Integer FSWatcher.getMaxListeners();

結果を返す:

  • Integer, デフォルトの制限数に戻す

listeners

クエリ オブジェクトの指定されたイベントのリスナーの配列

1
Array FSWatcher.listeners(String ev);

呼び出しパラメータ:

  • ev: 文字列、イベントの名前を指定

結果を返す:

  • Array、指定されたイベントのリスナーの配列を返します

listenerCount

クエリ オブジェクトの指定されたイベントのリスナーの数

1
Integer FSWatcher.listenerCount(String ev);

呼び出しパラメータ:

  • ev: 文字列、イベントの名前を指定

結果を返す:

  • Integer、指定されたイベントのリスナーの数を返します

eventNames

リスナーのイベント名を問い合わせる

1
Array FSWatcher.eventNames();

結果を返す:

  • Array、イベント名の配列を返します

emit

イベントを積極的にトリガーする

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

呼び出しパラメータ:

  • ev: 文字列、イベント名
  • args: ...、イベント ハンドラーに渡されるイベント パラメーター

結果を返す:

  • Boolean、イベントトリガー状態に戻り、レスポンスイベントがあればtrue、そうでなければfalseを返す

toString

オブジェクトの文字列表現を返します。通常は「[ネイティブ オブジェクト]」を返します。オブジェクトは独自の特性に従って再実装できます。

1
String FSWatcher.toString();

結果を返す:

  • String、オブジェクトの文字列表現を返します

toJSON

オブジェクトの JSON 形式の表現を返します。通常は、オブジェクトによって定義された読み取り可能な属性のコレクションを返します。

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

呼び出しパラメータ:

  • key: ストリング、未使用

結果を返す:

  • Value、シリアライズ可能なJSONを含む値を返します