オブジェクト組み込みオブジェクト
  1. 表紙
  2. 組み込みオブジェクト
  3. オブジェクトFSWatcher

オブジェクト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）;と同等の、 "file change"イベントの関数、クエリ、およびバインド。

1
Function FSWatcher.onchange;

onclose

on（ "close"、func）;と同等の、 "watcher close"イベントの関数、クエリ、およびバインド。

1
Function FSWatcher.onclose;

onerror

on（ "error"、func）;と同等の、 "erroroccurred"イベントの関数、クエリ、およびバインド。

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

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

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

呼び出しパラメーター：

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

戻り結果：

  • Object、チェーン呼び出しに便利なイベントオブジェクト自体を返します

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

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

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

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

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

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

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

1
String FSWatcher.toString();

戻り結果：

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

toJSON

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

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

呼び出しパラメーター：

  • key：文字列、未使用

戻り結果：

  • Value、シリアル化可能なJSONを含む値を返します
©Copyright2012-2021 fibjs.org |サポートしてください