Объект встроенный объект
  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 («изменение», func);

1
Function FSWatcher.onchange;

onclose

Функция, запрос и привязка события «закрытия наблюдателя», эквивалентного on («close», func);

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: String укажите название события
  • func: Функция, укажите функцию обработки событий

Результат возврата:

  • Object, Вернуть сам объект события, что удобно для цепного вызова

Привяжите обработчик события к объекту

1
Object FSWatcher.on(Object map);

Параметры звонка:

  • map: Object, укажите отношение сопоставления событий, имя свойства объекта будет использоваться как имя события, а значение свойства будет использоваться как функция обработки события

Результат возврата:

  • Object, Вернуть сам объект события, что удобно для цепного вызова

addListener

Привяжите обработчик события к объекту

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

Параметры звонка:

  • ev: String укажите название события
  • func: Функция, укажите функцию обработки событий

Результат возврата:

  • Object, Вернуть сам объект события, что удобно для цепного вызова

Привяжите обработчик события к объекту

1
Object FSWatcher.addListener(Object map);

Параметры звонка:

  • map: Object, укажите отношение сопоставления событий, имя свойства объекта будет использоваться как имя события, а значение свойства будет использоваться как функция обработки события

Результат возврата:

  • Object, Вернуть сам объект события, что удобно для цепного вызова

prependListener

Привяжите обработчик события к началу объекта

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

Параметры звонка:

  • ev: String укажите название события
  • func: Функция, укажите функцию обработки событий

Результат возврата:

  • Object, Вернуть сам объект события, что удобно для цепного вызова

Привяжите обработчик события к началу объекта

1
Object FSWatcher.prependListener(Object map);

Параметры звонка:

  • map: Object, укажите отношение сопоставления событий, имя свойства объекта будет использоваться как имя события, а значение свойства будет использоваться как функция обработки события

Результат возврата:

  • Object, Вернуть сам объект события, что удобно для цепного вызова

once

Привязать к объекту функцию одноразовой обработки событий, функция одноразовой обработки будет срабатывать только один раз

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

Параметры звонка:

  • ev: String укажите название события
  • func: Функция, укажите функцию обработки событий

Результат возврата:

  • Object, Вернуть сам объект события, что удобно для цепного вызова

Привязать к объекту функцию одноразовой обработки событий, функция одноразовой обработки будет срабатывать только один раз

1
Object FSWatcher.once(Object map);

Параметры звонка:

  • map: Object, укажите отношение сопоставления событий, имя свойства объекта будет использоваться как имя события, а значение свойства будет использоваться как функция обработки события

Результат возврата:

  • Object, Вернуть сам объект события, что удобно для цепного вызова

prependOnceListener

Привяжите обработчик события к началу объекта

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

Параметры звонка:

  • ev: String укажите название события
  • func: Функция, укажите функцию обработки событий

Результат возврата:

  • Object, Вернуть сам объект события, что удобно для цепного вызова

Привяжите обработчик события к началу объекта

1
Object FSWatcher.prependOnceListener(Object map);

Параметры звонка:

  • map: Object, укажите отношение сопоставления событий, имя свойства объекта будет использоваться как имя события, а значение свойства будет использоваться как функция обработки события

Результат возврата:

  • Object, Вернуть сам объект события, что удобно для цепного вызова

off

Отменить указанную функцию из очереди обработки объекта

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

Параметры звонка:

  • ev: String укажите название события
  • func: Функция, укажите функцию обработки событий

Результат возврата:

  • Object, Вернуть сам объект события, что удобно для цепного вызова

Отменить все функции в очереди обработки объекта

1
Object FSWatcher.off(String ev);

Параметры звонка:

  • ev: String укажите название события

Результат возврата:

  • Object, Вернуть сам объект события, что удобно для цепного вызова

Отменить указанную функцию из очереди обработки объекта

1
Object FSWatcher.off(Object map);

Параметры звонка:

  • map: Object, укажите отношение сопоставления событий, имя свойства объекта используется как имя события, а значение свойства используется как функция обработки события.

Результат возврата:

  • Object, Вернуть сам объект события, что удобно для цепного вызова

removeListener

Отменить указанную функцию из очереди обработки объекта

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

Параметры звонка:

  • ev: String укажите название события
  • func: Функция, укажите функцию обработки событий

Результат возврата:

  • Object, Вернуть сам объект события, что удобно для цепного вызова

Отменить все функции в очереди обработки объекта

1
Object FSWatcher.removeListener(String ev);

Параметры звонка:

  • ev: String укажите название события

Результат возврата:

  • Object, Вернуть сам объект события, что удобно для цепного вызова

Отменить указанную функцию из очереди обработки объекта

1
Object FSWatcher.removeListener(Object map);

Параметры звонка:

  • map: Object, укажите отношение сопоставления событий, имя свойства объекта используется как имя события, а значение свойства используется как функция обработки события.

Результат возврата:

  • Object, Вернуть сам объект события, что удобно для цепного вызова

removeAllListeners

Отменить все прослушиватели всех событий из очереди обработки объекта.Если событие указано, удалить всех прослушивателей указанного события.

1
Object FSWatcher.removeAllListeners(String ev);

Параметры звонка:

  • ev: String укажите название события

Результат возврата:

  • 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: String укажите название события

Результат возврата:

  • Array, Возвращает массив слушателей для указанного события

listenerCount

Количество слушателей для указанного события объекта запроса

1
Integer FSWatcher.listenerCount(String ev);

Параметры звонка:

  • ev: String укажите название события

Результат возврата:

  • Integer, Возвращает количество слушателей для указанного события

Количество слушателей для указанного события объекта запроса

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

Параметры звонка:

  • o: Значение, укажите объект запроса
  • ev: String укажите название события

Результат возврата:

  • Integer, Возвращает количество слушателей для указанного события

eventNames

Запросить имя события слушателя

1
Array FSWatcher.eventNames();

Результат возврата:

  • Array, Возвращает массив имен событий

emit

Активно запускать событие

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

Параметры звонка:

  • ev: Строка, название события
  • args: ..., параметры события, которые будут переданы обработчику события

Результат возврата:

  • Boolean, Вернитесь в состояние триггера события, верните истину, если есть событие ответа, в противном случае верните ложь

toString

Возвращает строковое представление объекта, обычно возвращает «[Native Object]», объект может быть повторно реализован в соответствии с его собственными характеристиками.

1
String FSWatcher.toString();

Результат возврата:

  • String, Возвращает строковое представление объекта

toJSON

Возвращает представление объекта в формате JSON, обычно возвращает набор читаемых атрибутов, определенных объектом.

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

Параметры звонка:

  • key: Строка, не используется

Результат возврата:

  • Value, Возвращает значение, содержащее сериализуемый JSON
© Copyright 2012-2021 fibjs.org | Поддержите нас