Objeto objeto integrado

Objeto FSWatcher

Objeto de observación del sistema de archivos

Cuando la llamada fs.watch(target)es exitosa, el tipo de objeto devuelto

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

Herencia

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

Propiedades estáticas

defaultMaxListeners

Entero, el número máximo global predeterminado de oyentes

1
static Integer FSWatcher.defaultMaxListeners;

Atributos de miembros

onchange

Función, consulta y vinculación del evento "cambio de archivo", equivalente a on ("change", func);

1
Function FSWatcher.onchange;

onclose

Funciona, consulta y vincula el evento "watcher close", equivalente a on ("close", func);

1
Function FSWatcher.onclose;

onerror

Función, consulta y enlace del evento "error ocurrido", equivalente a on ("error", func);

1
Function FSWatcher.onerror;

Función miembro

close

Cierre el Watcher y ya no recibirá los eventos de procesamiento de cambio de archivo correspondientes

1
FSWatcher.close();

on

Vincular un controlador de eventos al objeto

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

Parámetros de llamada:

  • ev: Cadena, especifique el nombre del evento
  • func: Función, especifique la función de procesamiento de eventos

Devolver resultado:

  • Object, Devuelve el objeto de evento en sí, que es conveniente para llamadas en cadena

Vincular un controlador de eventos al objeto

1
Object FSWatcher.on(Object map);

Parámetros de llamada:

  • map: Objeto, especifique la relación de mapeo de eventos, el nombre de la propiedad del objeto se usará como el nombre del evento y el valor de la propiedad se usará como la función de procesamiento de eventos

Devolver resultado:

  • Object, Devuelve el objeto de evento en sí, que es conveniente para llamadas en cadena

addListener

Vincular un controlador de eventos al objeto

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

Parámetros de llamada:

  • ev: Cadena, especifique el nombre del evento
  • func: Función, especifique la función de procesamiento de eventos

Devolver resultado:

  • Object, Devuelve el objeto de evento en sí, que es conveniente para llamadas en cadena

Vincular un controlador de eventos al objeto

1
Object FSWatcher.addListener(Object map);

Parámetros de llamada:

  • map: Objeto, especifique la relación de mapeo de eventos, el nombre de la propiedad del objeto se usará como el nombre del evento y el valor de la propiedad se usará como la función de procesamiento de eventos

Devolver resultado:

  • Object, Devuelve el objeto de evento en sí, que es conveniente para llamadas en cadena

prependListener

Vincular un controlador de eventos al inicio del objeto

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

Parámetros de llamada:

  • ev: Cadena, especifique el nombre del evento
  • func: Función, especifique la función de procesamiento de eventos

Devolver resultado:

  • Object, Devuelve el objeto de evento en sí, que es conveniente para llamadas en cadena

Vincular un controlador de eventos al inicio del objeto

1
Object FSWatcher.prependListener(Object map);

Parámetros de llamada:

  • map: Objeto, especifique la relación de mapeo de eventos, el nombre de la propiedad del objeto se usará como el nombre del evento y el valor de la propiedad se usará como la función de procesamiento de eventos

Devolver resultado:

  • Object, Devuelve el objeto de evento en sí, que es conveniente para llamadas en cadena

once

Vincular una función de procesamiento de eventos de una sola vez al objeto, la función de procesamiento de una sola vez solo se activará una vez

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

Parámetros de llamada:

  • ev: Cadena, especifique el nombre del evento
  • func: Función, especifique la función de procesamiento de eventos

Devolver resultado:

  • Object, Devuelve el objeto de evento en sí, que es conveniente para llamadas en cadena

Vincular una función de procesamiento de eventos de una sola vez al objeto, la función de procesamiento de una sola vez solo se activará una vez

1
Object FSWatcher.once(Object map);

Parámetros de llamada:

  • map: Objeto, especifique la relación de mapeo de eventos, el nombre de la propiedad del objeto se usará como el nombre del evento y el valor de la propiedad se usará como la función de procesamiento de eventos

Devolver resultado:

  • Object, Devuelve el objeto de evento en sí, que es conveniente para llamadas en cadena

prependOnceListener

Vincular un controlador de eventos al inicio del objeto

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

Parámetros de llamada:

  • ev: Cadena, especifique el nombre del evento
  • func: Función, especifique la función de procesamiento de eventos

Devolver resultado:

  • Object, Devuelve el objeto de evento en sí, que es conveniente para llamadas en cadena

Vincular un controlador de eventos al inicio del objeto

1
Object FSWatcher.prependOnceListener(Object map);

Parámetros de llamada:

  • map: Objeto, especifique la relación de mapeo de eventos, el nombre de la propiedad del objeto se usará como el nombre del evento y el valor de la propiedad se usará como la función de procesamiento de eventos

Devolver resultado:

  • Object, Devuelve el objeto de evento en sí, que es conveniente para llamadas en cadena

off

Cancelar la función especificada de la cola de procesamiento de objetos

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

Parámetros de llamada:

  • ev: Cadena, especifique el nombre del evento
  • func: Función, especifique la función de procesamiento de eventos

Devolver resultado:

  • Object, Devuelve el objeto de evento en sí, que es conveniente para llamadas en cadena

Cancelar todas las funciones en la cola de procesamiento de objetos

1
Object FSWatcher.off(String ev);

Parámetros de llamada:

  • ev: Cadena, especifique el nombre del evento

Devolver resultado:

  • Object, Devuelve el objeto de evento en sí, que es conveniente para llamadas en cadena

Cancelar la función especificada de la cola de procesamiento de objetos

1
Object FSWatcher.off(Object map);

Parámetros de llamada:

  • map: Objeto, especifique la relación de mapeo de eventos, el nombre de la propiedad del objeto se usa como el nombre del evento y el valor de la propiedad se usa como la función de procesamiento de eventos

Devolver resultado:

  • Object, Devuelve el objeto de evento en sí, que es conveniente para llamadas en cadena

removeListener

Cancelar la función especificada de la cola de procesamiento de objetos

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

Parámetros de llamada:

  • ev: Cadena, especifique el nombre del evento
  • func: Función, especifique la función de procesamiento de eventos

Devolver resultado:

  • Object, Devuelve el objeto de evento en sí, que es conveniente para llamadas en cadena

Cancelar todas las funciones en la cola de procesamiento de objetos

1
Object FSWatcher.removeListener(String ev);

Parámetros de llamada:

  • ev: Cadena, especifique el nombre del evento

Devolver resultado:

  • Object, Devuelve el objeto de evento en sí, que es conveniente para llamadas en cadena

Cancelar la función especificada de la cola de procesamiento de objetos

1
Object FSWatcher.removeListener(Object map);

Parámetros de llamada:

  • map: Objeto, especifique la relación de mapeo de eventos, el nombre de la propiedad del objeto se usa como el nombre del evento y el valor de la propiedad se usa como la función de procesamiento de eventos

Devolver resultado:

  • Object, Devuelve el objeto de evento en sí, que es conveniente para llamadas en cadena

removeAllListeners

Cancele todos los oyentes de todos los eventos de la cola de procesamiento de objetos. Si se especifica un evento, elimine todos los oyentes del evento especificado.

1
Object FSWatcher.removeAllListeners(String ev);

Parámetros de llamada:

  • ev: Cadena, especifique el nombre del evento

Devolver resultado:

  • Object, Devuelve el objeto de evento en sí, que es conveniente para llamadas en cadena

Cancele todos los oyentes de todos los eventos de la cola de procesamiento de objetos. Si se especifica un evento, elimine todos los oyentes del evento especificado.

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

Parámetros de llamada:

  • evs: Matriz, especifique el nombre del evento

Devolver resultado:

  • Object, Devuelve el objeto de evento en sí, que es conveniente para llamadas en cadena

setMaxListeners

El límite predeterminado del número de oyentes, solo por compatibilidad

1
FSWatcher.setMaxListeners(Integer n);

Parámetros de llamada:

  • n: Entero, especifique el número de eventos

getMaxListeners

Obtenga el límite predeterminado de la cantidad de oyentes, solo por compatibilidad

1
Integer FSWatcher.getMaxListeners();

Devolver resultado:

  • Integer, Vuelve al número límite predeterminado

listeners

Matriz de oyentes para el evento especificado del objeto de consulta

1
Array FSWatcher.listeners(String ev);

Parámetros de llamada:

  • ev: Cadena, especifique el nombre del evento

Devolver resultado:

  • Array, Devuelve una matriz de oyentes para el evento especificado.

listenerCount

El número de oyentes para el evento especificado del objeto de consulta.

1
Integer FSWatcher.listenerCount(String ev);

Parámetros de llamada:

  • ev: Cadena, especifique el nombre del evento

Devolver resultado:

  • Integer, Devuelve el número de oyentes para el evento especificado.

eventNames

Consultar el nombre del evento del oyente

1
Array FSWatcher.eventNames();

Devolver resultado:

  • Array, Devuelve una matriz de nombres de eventos.

emit

Activar un evento de forma activa

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

Parámetros de llamada:

  • ev: Cadena, nombre del evento
  • args: ..., parámetros de evento, que se pasarán al controlador de eventos

Devolver resultado:

  • Boolean, Vuelve al estado de activación del evento, devuelve verdadero si hay un evento de respuesta, de lo contrario devuelve falso

toString

Devuelve la representación en cadena del objeto, generalmente devuelve "[Native Object]", el objeto se puede volver a implementar de acuerdo con sus propias características

1
String FSWatcher.toString();

Devolver resultado:

  • String, Devuelve la representación de cadena del objeto

toJSON

Devuelve la representación en formato JSON del objeto, generalmente devuelve una colección de atributos legibles definidos por el objeto

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

Parámetros de llamada:

  • key: Cadena, sin usar

Devolver resultado:

  • Value, Devuelve un valor que contiene JSON serializable