Objet objet intégré

Objet FSWatcher

observateur du système de fichiers

Lorsque l'appel fs.watch(target)réussit , un objet de ce type est retourné

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 ...> } });

relation d'héritage

#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()

propriétés statiques

defaultMaxListeners

Entier, le nombre maximal global d'écouteurs par défaut

1
static Integer FSWatcher.defaultMaxListeners;

Propriétés des membres

onchange

Fonctionne, interroge et lie l'événement "changement de fichier", équivalent à on("change", func);

1
Function FSWatcher.onchange;

onclose

Fonctionne, interroge et lie l'événement "watcher close", équivalent à on("close", func);

1
Function FSWatcher.onclose;

onerror

Fonctionne, interroge et lie l'événement "une erreur s'est produite", équivalent à on("error", func);

1
Function FSWatcher.onerror;

fonction membre

close

Fermez le Watcher et ne recevez plus les événements de traitement de changement de fichier correspondants

1
FSWatcher.close();

on

Lier un gestionnaire d'événements à un objet

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

Paramètres d'appel :

  • ev: String, spécifie le nom de l'événement
  • func: Function, spécifie la fonction du gestionnaire d'événements

Retourner le résultat :

  • Object, renvoie l'objet événement lui-même pour faciliter le chaînage

Lier un gestionnaire d'événements à un objet

1
Object FSWatcher.on(Object map);

Paramètres d'appel :

  • map: Objet, spécifiez la relation de mappage d'événement, le nom de la propriété de l'objet sera utilisé comme nom d'événement et la valeur de la propriété sera utilisée comme fonction de gestionnaire d'événement

Retourner le résultat :

  • Object, renvoie l'objet événement lui-même pour faciliter le chaînage

addListener

Lier un gestionnaire d'événements à un objet

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

Paramètres d'appel :

  • ev: String, spécifie le nom de l'événement
  • func: Function, spécifie la fonction du gestionnaire d'événements

Retourner le résultat :

  • Object, renvoie l'objet événement lui-même pour faciliter le chaînage

Lier un gestionnaire d'événements à un objet

1
Object FSWatcher.addListener(Object map);

Paramètres d'appel :

  • map: Objet, spécifiez la relation de mappage d'événement, le nom de la propriété de l'objet sera utilisé comme nom d'événement et la valeur de la propriété sera utilisée comme fonction de gestionnaire d'événement

Retourner le résultat :

  • Object, renvoie l'objet événement lui-même pour faciliter le chaînage

prependListener

Lier un gestionnaire d'événements au début de l'objet

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

Paramètres d'appel :

  • ev: String, spécifie le nom de l'événement
  • func: Function, spécifie la fonction du gestionnaire d'événements

Retourner le résultat :

  • Object, renvoie l'objet événement lui-même pour faciliter le chaînage

Lier un gestionnaire d'événements au début de l'objet

1
Object FSWatcher.prependListener(Object map);

Paramètres d'appel :

  • map: Objet, spécifiez la relation de mappage d'événement, le nom de la propriété de l'objet sera utilisé comme nom d'événement et la valeur de la propriété sera utilisée comme fonction de gestionnaire d'événement

Retourner le résultat :

  • Object, renvoie l'objet événement lui-même pour faciliter le chaînage

once

Liez un gestionnaire d'événements à usage unique à l'objet, le gestionnaire à usage unique ne se déclenchera qu'une seule fois

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

Paramètres d'appel :

  • ev: String, spécifie le nom de l'événement
  • func: Function, spécifie la fonction du gestionnaire d'événements

Retourner le résultat :

  • Object, renvoie l'objet événement lui-même pour faciliter le chaînage

Liez un gestionnaire d'événements à usage unique à l'objet, le gestionnaire à usage unique ne se déclenchera qu'une seule fois

1
Object FSWatcher.once(Object map);

Paramètres d'appel :

  • map: Objet, spécifiez la relation de mappage d'événement, le nom de la propriété de l'objet sera utilisé comme nom d'événement et la valeur de la propriété sera utilisée comme fonction de gestionnaire d'événement

Retourner le résultat :

  • Object, renvoie l'objet événement lui-même pour faciliter le chaînage

prependOnceListener

Lier un gestionnaire d'événements au début de l'objet

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

Paramètres d'appel :

  • ev: String, spécifie le nom de l'événement
  • func: Function, spécifie la fonction du gestionnaire d'événements

Retourner le résultat :

  • Object, renvoie l'objet événement lui-même pour faciliter le chaînage

Lier un gestionnaire d'événements au début de l'objet

1
Object FSWatcher.prependOnceListener(Object map);

Paramètres d'appel :

  • map: Objet, spécifiez la relation de mappage d'événement, le nom de la propriété de l'objet sera utilisé comme nom d'événement et la valeur de la propriété sera utilisée comme fonction de gestionnaire d'événement

Retourner le résultat :

  • Object, renvoie l'objet événement lui-même pour faciliter le chaînage

off

annuler la fonction spécifiée de la file d'attente de traitement d'objet

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

Paramètres d'appel :

  • ev: String, spécifie le nom de l'événement
  • func: Function, spécifie la fonction du gestionnaire d'événements

Retourner le résultat :

  • Object, renvoie l'objet événement lui-même pour faciliter le chaînage

Annuler toutes les fonctions dans la file d'attente de traitement d'objet

1
Object FSWatcher.off(String ev);

Paramètres d'appel :

  • ev: String, spécifie le nom de l'événement

Retourner le résultat :

  • Object, renvoie l'objet événement lui-même pour faciliter le chaînage

annuler la fonction spécifiée de la file d'attente de traitement d'objet

1
Object FSWatcher.off(Object map);

Paramètres d'appel :

  • map: Objet, spécifie la relation de mappage d'événement, le nom de la propriété de l'objet est utilisé comme nom d'événement et la valeur de la propriété est utilisée comme fonction de gestionnaire d'événement

Retourner le résultat :

  • Object, renvoie l'objet événement lui-même pour faciliter le chaînage

removeListener

annuler la fonction spécifiée de la file d'attente de traitement d'objet

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

Paramètres d'appel :

  • ev: String, spécifie le nom de l'événement
  • func: Function, spécifie la fonction du gestionnaire d'événements

Retourner le résultat :

  • Object, renvoie l'objet événement lui-même pour faciliter le chaînage

Annuler toutes les fonctions dans la file d'attente de traitement d'objet

1
Object FSWatcher.removeListener(String ev);

Paramètres d'appel :

  • ev: String, spécifie le nom de l'événement

Retourner le résultat :

  • Object, renvoie l'objet événement lui-même pour faciliter le chaînage

annuler la fonction spécifiée de la file d'attente de traitement d'objet

1
Object FSWatcher.removeListener(Object map);

Paramètres d'appel :

  • map: Objet, spécifie la relation de mappage d'événement, le nom de la propriété de l'objet est utilisé comme nom d'événement et la valeur de la propriété est utilisée comme fonction de gestionnaire d'événement

Retourner le résultat :

  • Object, renvoie l'objet événement lui-même pour faciliter le chaînage

removeAllListeners

Annule tous les écouteurs de tous les événements de la file d'attente de traitement de l'objet ou, si un événement est spécifié, supprime tous les écouteurs de l'événement spécifié.

1
Object FSWatcher.removeAllListeners(String ev);

Paramètres d'appel :

  • ev: String, spécifie le nom de l'événement

Retourner le résultat :

  • Object, renvoie l'objet événement lui-même pour faciliter le chaînage

Annule tous les écouteurs de tous les événements de la file d'attente de traitement de l'objet ou, si un événement est spécifié, supprime tous les écouteurs de l'événement spécifié.

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

Paramètres d'appel :

  • evs: Array, spécifiant le nom de l'événement

Retourner le résultat :

  • Object, renvoie l'objet événement lui-même pour faciliter le chaînage

setMaxListeners

La limite par défaut du nombre d'auditeurs, uniquement pour la compatibilité

1
FSWatcher.setMaxListeners(Integer n);

Paramètres d'appel :

  • n: Entier, spécifie le nombre d'événements

getMaxListeners

Obtient le nombre de limites par défaut pour les écouteurs, uniquement pour la compatibilité

1
Integer FSWatcher.getMaxListeners();

Retourner le résultat :

  • Integer, renvoie le nombre limite par défaut

listeners

Interroger le tableau d'écouteurs pour l'événement spécifié de l'objet

1
Array FSWatcher.listeners(String ev);

Paramètres d'appel :

  • ev: String, spécifie le nom de l'événement

Retourner le résultat :

  • Array, renvoie un tableau d'écouteurs pour l'événement spécifié

listenerCount

Le nombre d'écouteurs pour l'événement spécifié de l'objet de requête

1
Integer FSWatcher.listenerCount(String ev);

Paramètres d'appel :

  • ev: String, spécifie le nom de l'événement

Retourner le résultat :

  • Integer, renvoie le nombre d'auditeurs pour l'événement spécifié

Le nombre d'écouteurs pour l'événement spécifié de l'objet de requête

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

Paramètres d'appel :

  • o: Valeur, spécifie l'objet de la requête
  • ev: String, spécifie le nom de l'événement

Retourner le résultat :

  • Integer, renvoie le nombre d'auditeurs pour l'événement spécifié

eventNames

Nom de l'événement de l'écouteur de requête

1
Array FSWatcher.eventNames();

Retourner le résultat :

  • Array, renvoie un tableau de noms d'événements

emit

Déclencher activement un événement

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

Paramètres d'appel :

  • ev: Chaîne, nom de l'événement
  • args: ..., paramètres d'événement, qui seront passés au gestionnaire d'événement

Retourner le résultat :

  • Boolean, renvoie l'état du déclencheur d'événement, renvoie vrai s'il y a un événement de réponse, sinon renvoie faux

toString

Renvoie la représentation sous forme de chaîne de l'objet, renvoie généralement "[Native Object]", l'objet peut être réimplémenté selon ses propres caractéristiques

1
String FSWatcher.toString();

Retourner le résultat :

  • String, renvoie la représentation sous forme de chaîne de l'objet

toJSON

Renvoie la représentation au format JSON de l'objet, renvoie généralement l'ensemble des propriétés lisibles définies par l'objet

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

Paramètres d'appel :

  • key: Chaîne, inutilisée

Retourner le résultat :

  • Value, renvoie une valeur contenant du JSON sérialisable