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

オブジェクト 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

ウォッチャーを閉じて、対応するファイル変更処理イベントを受信しなくなります

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

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

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

呼び出しパラメーター:

  • ev: 文字列、イベントの名前を指定します
  • func: 関数、イベント ハンドラ関数を指定します。

返される結果:

  • Object、チェーンを簡単にするためにイベントオブジェクト自体を返します

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

1
Object FSWatcher.prependListener(Object map);

呼び出しパラメーター:

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

返される結果:

  • Object、チェーンを簡単にするためにイベントオブジェクト自体を返します

once

ワンタイム イベント ハンドラーをオブジェクトにバインドします。ワンタイム ハンドラーは 1 回だけ起動します。

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

呼び出しパラメーター:

  • ev: 文字列、イベントの名前を指定します
  • func: 関数、イベント ハンドラ関数を指定します。

返される結果:

  • Object、チェーンを簡単にするためにイベントオブジェクト自体を返します

ワンタイム イベント ハンドラーをオブジェクトにバインドします。ワンタイム ハンドラーは 1 回だけ起動します。

1
Object FSWatcher.once(Object map);

呼び出しパラメーター:

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

返される結果:

  • Object、チェーンを簡単にするためにイベントオブジェクト自体を返します

prependOnceListener

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

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

呼び出しパラメーター:

  • ev: 文字列、イベントの名前を指定します
  • func: 関数、イベント ハンドラ関数を指定します。

返される結果:

  • Object、チェーンを簡単にするためにイベントオブジェクト自体を返します

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

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、指定されたイベントのリスナーの数を返します

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

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

呼び出しパラメーター:

  • o: 値、クエリのオブジェクトを指定します
  • ev: 文字列、イベントの名前を指定します

返される結果:

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

eventNames

クエリ リスナー イベント名

1
Array FSWatcher.eventNames();

返される結果:

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

emit

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

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

呼び出しパラメーター:

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

返される結果:

  • Boolean、イベント トリガー ステータスを返します。応答イベントがある場合は true を返し、そうでない場合は false を返します。

toString

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

1
String FSWatcher.toString();

返される結果:

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

toJSON

オブジェクトの JSON 形式表現を返します。通常は、オブジェクトによって定義された読み取り可能なプロパティのセットを返します

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

呼び出しパラメーター:

  • key:文字列、未使用

返される結果:

  • Value、シリアル化可能な JSON を含む値を返します