ObjectFSWatcher

oggetto di controllo del file system

Quando la chiamata fs.watch(target)ha esito positivo, viene restituito un oggetto di questo tipo

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

// calling fs.watch with callback and options
fs.watch('./tmp', {
    encoding: 'buffer'
}, (eventType, filename) => {
    if (filename) {
        console.log(filename);
        // Prints: <Buffer ...>
    }
});

rapporto ereditario

proprietà statiche

defaultMaxListeners

Intero, il numero massimo globale predefinito di ascoltatori

1
static Integer FSWatcher.defaultMaxListeners;

proprietà dei membri

onchange

Funzione, interroga e associa l'evento "modifica file", equivalente a on("modifica", func);

1
Function FSWatcher.onchange;

onclose

Funzione, interroga e associa l'evento "watcher close", equivalente a on("close", func);

1
Function FSWatcher.onclose;

onerror

Funzione, interroga e associa l'evento di "occorrenza di errore", equivalente a on("errore", func);

1
Function FSWatcher.onerror;

funzione membro

close

Chiudi Watcher e non ricevi più i corrispondenti eventi di elaborazione delle modifiche ai file.

1FSWatcher.close();

on

Associa un gestore eventi all'oggetto

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

Parametri di chiamata:

ev: String, specifica il nome dell'evento
func: Funzione, specifica la funzione di elaborazione dell'evento

Risultati restituiti:

Object, restituisce l'oggetto evento stesso per facilitare le chiamate a catena

Associa un gestore eventi all'oggetto

1
Object FSWatcher.on(Object map);

Parametri di chiamata:

map: Oggetto, specifica la relazione di mappatura degli eventi, il nome dell'attributo dell'oggetto verrà utilizzato come nome dell'evento e il valore dell'attributo verrà utilizzato come funzione di elaborazione dell'evento

Risultati restituiti:

Object, restituisce l'oggetto evento stesso per facilitare le chiamate a catena

addListener

Associa un gestore eventi all'oggetto

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

Parametri di chiamata:

ev: String, specifica il nome dell'evento
func: Funzione, specifica la funzione di elaborazione dell'evento

Risultati restituiti:

Object, restituisce l'oggetto evento stesso per facilitare le chiamate a catena

Associa un gestore eventi all'oggetto

1
Object FSWatcher.addListener(Object map);

Parametri di chiamata:

map: Oggetto, specifica la relazione di mappatura degli eventi, il nome dell'attributo dell'oggetto verrà utilizzato come nome dell'evento e il valore dell'attributo verrà utilizzato come funzione di elaborazione dell'evento

Risultati restituiti:

Object, restituisce l'oggetto evento stesso per facilitare le chiamate a catena

prependListener

Associa un gestore eventi all'origine dell'oggetto

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

Parametri di chiamata:

ev: String, specifica il nome dell'evento
func: Funzione, specifica la funzione di elaborazione dell'evento

Risultati restituiti:

Object, restituisce l'oggetto evento stesso per facilitare le chiamate a catena

Associa un gestore eventi all'origine dell'oggetto

1
Object FSWatcher.prependListener(Object map);

Parametri di chiamata:

map: Oggetto, specifica la relazione di mappatura degli eventi, il nome dell'attributo dell'oggetto verrà utilizzato come nome dell'evento e il valore dell'attributo verrà utilizzato come funzione di elaborazione dell'evento

Risultati restituiti:

Object, restituisce l'oggetto evento stesso per facilitare le chiamate a catena

once

Associa un gestore di eventi monouso all'oggetto. Il gestore di eventi monouso verrà attivato solo una volta.

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

Parametri di chiamata:

ev: String, specifica il nome dell'evento
func: Funzione, specifica la funzione di elaborazione dell'evento

Risultati restituiti:

Object, restituisce l'oggetto evento stesso per facilitare le chiamate a catena

Associa un gestore di eventi monouso all'oggetto. Il gestore di eventi monouso verrà attivato solo una volta.

1
Object FSWatcher.once(Object map);

Parametri di chiamata:

map: Oggetto, specifica la relazione di mappatura degli eventi, il nome dell'attributo dell'oggetto verrà utilizzato come nome dell'evento e il valore dell'attributo verrà utilizzato come funzione di elaborazione dell'evento

Risultati restituiti:

Object, restituisce l'oggetto evento stesso per facilitare le chiamate a catena

prependOnceListener

Associa un gestore eventi all'origine dell'oggetto

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

Parametri di chiamata:

ev: String, specifica il nome dell'evento
func: Funzione, specifica la funzione di elaborazione dell'evento

Risultati restituiti:

Object, restituisce l'oggetto evento stesso per facilitare le chiamate a catena

Associa un gestore eventi all'origine dell'oggetto

1
Object FSWatcher.prependOnceListener(Object map);

Parametri di chiamata:

map: Oggetto, specifica la relazione di mappatura degli eventi, il nome dell'attributo dell'oggetto verrà utilizzato come nome dell'evento e il valore dell'attributo verrà utilizzato come funzione di elaborazione dell'evento

Risultati restituiti:

Object, restituisce l'oggetto evento stesso per facilitare le chiamate a catena

off

Annullare l'assegnazione di una funzione dalla coda di elaborazione degli oggetti

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

Parametri di chiamata:

ev: String, specifica il nome dell'evento
func: Funzione, specifica la funzione di elaborazione dell'evento

Risultati restituiti:

Object, restituisce l'oggetto evento stesso per facilitare le chiamate a catena

Annulla tutte le funzioni nella coda di elaborazione degli oggetti

1
Object FSWatcher.off(String ev);

Parametri di chiamata:

ev: String, specifica il nome dell'evento

Risultati restituiti:

Object, restituisce l'oggetto evento stesso per facilitare le chiamate a catena

Annullare l'assegnazione di una funzione dalla coda di elaborazione degli oggetti

1
Object FSWatcher.off(Object map);

Parametri di chiamata:

map: Oggetto, specifica la relazione di mappatura degli eventi, il nome dell'attributo dell'oggetto viene utilizzato come nome dell'evento e il valore dell'attributo viene utilizzato come funzione di elaborazione dell'evento

Risultati restituiti:

Object, restituisce l'oggetto evento stesso per facilitare le chiamate a catena

removeListener

Annullare l'assegnazione di una funzione dalla coda di elaborazione degli oggetti

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

Parametri di chiamata:

ev: String, specifica il nome dell'evento
func: Funzione, specifica la funzione di elaborazione dell'evento

Risultati restituiti:

Object, restituisce l'oggetto evento stesso per facilitare le chiamate a catena

Annulla tutte le funzioni nella coda di elaborazione degli oggetti

1
Object FSWatcher.removeListener(String ev);

Parametri di chiamata:

ev: String, specifica il nome dell'evento

Risultati restituiti:

Object, restituisce l'oggetto evento stesso per facilitare le chiamate a catena

Annullare l'assegnazione di una funzione dalla coda di elaborazione degli oggetti

1
Object FSWatcher.removeListener(Object map);

Parametri di chiamata:

map: Oggetto, specifica la relazione di mappatura degli eventi, il nome dell'attributo dell'oggetto viene utilizzato come nome dell'evento e il valore dell'attributo viene utilizzato come funzione di elaborazione dell'evento

Risultati restituiti:

Object, restituisce l'oggetto evento stesso per facilitare le chiamate a catena

removeAllListeners

Annulla tutti i listener per tutti gli eventi dalla coda di elaborazione dell'oggetto. Se viene specificato un evento, rimuove tutti i listener per l'evento specificato.

1
Object FSWatcher.removeAllListeners(String ev);

Parametri di chiamata:

ev: String, specifica il nome dell'evento

Risultati restituiti:

Object, restituisce l'oggetto evento stesso per facilitare le chiamate a catena

Annulla tutti i listener per tutti gli eventi dalla coda di elaborazione dell'oggetto. Se viene specificato un evento, rimuove tutti i listener per l'evento specificato.

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

Parametri di chiamata:

evs: Array, specifica il nome dell'evento

Risultati restituiti:

Object, restituisce l'oggetto evento stesso per facilitare le chiamate a catena

setMaxListeners

Il limite predefinito sul numero di ascoltatori, solo per compatibilità

1FSWatcher.setMaxListeners(Integer n);

Parametri di chiamata:

n: Numero intero, specifica il numero di eventi

getMaxListeners

Ottiene il numero limite predefinito di ascoltatori, solo per compatibilità

1Integer FSWatcher.getMaxListeners();

Risultati restituiti:

Integer, restituisce la quantità limite predefinita

listeners

Interroga l'array del listener per l'evento specificato dell'oggetto

1
Array FSWatcher.listeners(String ev);

Parametri di chiamata:

ev: String, specifica il nome dell'evento

Risultati restituiti:

Array, restituisce l'array del listener per l'evento specificato

listenerCount

Interroga il numero di ascoltatori per l'evento specificato dell'oggetto

1
Integer FSWatcher.listenerCount(String ev);

Parametri di chiamata:

ev: String, specifica il nome dell'evento

Risultati restituiti:

Integer, restituisce il numero di ascoltatori per l'evento specificato

Interroga il numero di ascoltatori per l'evento specificato dell'oggetto

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

Parametri di chiamata:

o: Valore, specifica l'oggetto della query
ev: String, specifica il nome dell'evento

Risultati restituiti:

Integer, restituisce il numero di ascoltatori per l'evento specificato

eventNames

Interroga il nome dell'evento del listener

1
Array FSWatcher.eventNames();

Risultati restituiti:

Array, restituisce una matrice di nomi di eventi

emit

Attiva attivamente un evento

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

Parametri di chiamata:

ev: stringa, nome dell'evento
args: ..., i parametri dell'evento verranno passati alla funzione di elaborazione degli eventi

Risultati restituiti:

Boolean, restituisce lo stato di attivazione dell'evento, restituisce true se è presente un evento di risposta, altrimenti restituisce false

toString

Restituisce la rappresentazione in formato stringa dell'oggetto. Generalmente viene restituito "[Oggetto nativo]". L'oggetto può essere reimplementato in base alle proprie caratteristiche.

1
String FSWatcher.toString();

Risultati restituiti:

String, restituisce la rappresentazione di stringa dell'oggetto

toJSON

Restituisce una rappresentazione in formato JSON dell'oggetto, generalmente restituendo una raccolta di proprietà leggibili definite dall'oggetto.

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

Parametri di chiamata:

key: Stringa, non utilizzata

Risultati restituiti:

Value, restituisce un valore contenente JSON serializzabile

Guida allo sviluppo

Modulo base

oggetti incorporati

modulo comunitario

ObjectFSWatcher

rapporto ereditario

proprietà statiche

defaultMaxListeners

proprietà dei membri

onchange

onclose

onerror

funzione membro

close

on

addListener

prependListener

once

prependOnceListener

off

removeListener

removeAllListeners

setMaxListeners

getMaxListeners

listeners

listenerCount

eventNames

emit

toString

toJSON