Obxecto incorporado

Object StatsWatcher

Obxecto observado de estatísticas de ficheiro

Cando a chamada fs.watchFile(target, onchange)ten éxito, devolve o tipo de obxecto

1 2 3 4 5 6 7
var fs = require("fs"); var statsWatcher = fs.watchFile(target, (curStat, prevStat) => { // process // ... statsWatcher.unref(); });

Teña en conta que a devolución de chamada por cambio activarase cando e só cando cambie o atributo mtime do destino do ficheiro de destino observado

Simplemente acceder ao destino do ficheiro de destino non desencadeará a devolución de chamada por cambio.

Se chama fs.watchFile(target), o ficheiro ou directorio de destino representado non existiría, entón non se chamará a devolución de chamada ata que se cree o destino, comezará a chamarse a devolución de chamada. Se o observador de traballo en ruta,) elimínase o ficheiro de destino, Non no futuro xeraranse máis devolucións de chamada

Herdanza

#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>StatsWatcher|onchange|close();ref();unref()] [object] <:- [EventEmitter] [EventEmitter] <:- [StatsWatcher] EventEmitter new EventEmitter() EventEmitter defaultMaxListeners on() addListener() prependListener() once() prependOnceListener() off() removeListener() removeAllListeners() setMaxListeners() getMaxListeners() listeners() listenerCount() eventNames() emit() StatsWatcher onchange close() ref() unref() object toString() toJSON()

Propiedades estáticas

defaultMaxListeners

Entero, o número máximo predeterminado global de oíntes

1
static Integer StatsWatcher.defaultMaxListeners;

Atributos dos membros

onchange

Función, consulta e vinculación do evento "file change", equivalente a on ("change", func);

1
Function StatsWatcher.onchange;

Función de membro

close

Deixa de observar a ruta do ficheiro de destino, borra o reconto de referencia (xa non mantén o proceso)

1
StatsWatcher.close();

ref

Aumenta o número de referencias e dille a fibjs que non saian do proceso mentres o observador aínda estea en uso.

1
StatsWatcher StatsWatcher.ref();

Resultado de volta:

  • StatsWatcher, Return StatsWatcher en si

A través do fs.watchFile()resultado predeterminado de StatsWatcher chamouse método, o predeterminado manterá o proceso.


unref

Diminuír o reconto de referencia

1
StatsWatcher StatsWatcher.unref();

Resultado de volta:

  • StatsWatcher, Return StatsWatcher en si

on

Vincula un controlador de eventos ao obxecto

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

Parámetros de chamada:

  • ev: Cadea, especifica o nome do evento
  • func: Función, especifica a función de procesamento de eventos

Resultado de volta:

  • Object, Devolve o obxecto de evento en si, o que é conveniente para a chamada en cadea

Vincula un controlador de eventos ao obxecto

1
Object StatsWatcher.on(Object map);

Parámetros de chamada:

  • map: Obxecto, especifique a relación de asignación de eventos, o nome da propiedade do obxecto usarase como nome do evento e o valor da propiedade usarase como función de procesamento de eventos.

Resultado de volta:

  • Object, Devolve o obxecto de evento en si, o que é conveniente para a chamada en cadea

addListener

Vincula un controlador de eventos ao obxecto

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

Parámetros de chamada:

  • ev: Cadea, especifica o nome do evento
  • func: Función, especifica a función de procesamento de eventos

Resultado de volta:

  • Object, Devolve o obxecto de evento en si, o que é conveniente para a chamada en cadea

Vincula un controlador de eventos ao obxecto

1
Object StatsWatcher.addListener(Object map);

Parámetros de chamada:

  • map: Obxecto, especifique a relación de asignación de eventos, o nome da propiedade do obxecto usarase como nome do evento e o valor da propiedade usarase como función de procesamento de eventos.

Resultado de volta:

  • Object, Devolve o obxecto de evento en si, o que é conveniente para a chamada en cadea

prependListener

Vincula un controlador de eventos ao comezo do obxecto

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

Parámetros de chamada:

  • ev: Cadea, especifica o nome do evento
  • func: Función, especifica a función de procesamento de eventos

Resultado de volta:

  • Object, Devolve o obxecto de evento en si, o que é conveniente para a chamada en cadea

Vincula un controlador de eventos ao comezo do obxecto

1
Object StatsWatcher.prependListener(Object map);

Parámetros de chamada:

  • map: Obxecto, especifique a relación de asignación de eventos, o nome da propiedade do obxecto usarase como nome do evento e o valor da propiedade usarase como función de procesamento de eventos.

Resultado de volta:

  • Object, Devolve o obxecto de evento en si, o que é conveniente para a chamada en cadea

once

Vincula unha función de procesamento de eventos dunha soa vez ao obxecto, a función de procesamento única só se activará unha vez

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

Parámetros de chamada:

  • ev: Cadea, especifica o nome do evento
  • func: Función, especifica a función de procesamento de eventos

Resultado de volta:

  • Object, Devolve o obxecto de evento en si, o que é conveniente para a chamada en cadea

Vincula unha función de procesamento de eventos dunha soa vez ao obxecto, a función de procesamento única só se activará unha vez

1
Object StatsWatcher.once(Object map);

Parámetros de chamada:

  • map: Obxecto, especifique a relación de asignación de eventos, o nome da propiedade do obxecto usarase como nome do evento e o valor da propiedade usarase como función de procesamento de eventos.

Resultado de volta:

  • Object, Devolve o obxecto de evento en si, o que é conveniente para a chamada en cadea

prependOnceListener

Vincula un controlador de eventos ao comezo do obxecto

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

Parámetros de chamada:

  • ev: Cadea, especifica o nome do evento
  • func: Función, especifica a función de procesamento de eventos

Resultado de volta:

  • Object, Devolve o obxecto de evento en si, o que é conveniente para a chamada en cadea

Vincula un controlador de eventos ao comezo do obxecto

1
Object StatsWatcher.prependOnceListener(Object map);

Parámetros de chamada:

  • map: Obxecto, especifique a relación de asignación de eventos, o nome da propiedade do obxecto usarase como nome do evento e o valor da propiedade usarase como función de procesamento de eventos.

Resultado de volta:

  • Object, Devolve o obxecto de evento en si, o que é conveniente para a chamada en cadea

off

Cancelar a función especificada da cola de procesamento de obxectos

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

Parámetros de chamada:

  • ev: Cadea, especifica o nome do evento
  • func: Función, especifica a función de procesamento de eventos

Resultado de volta:

  • Object, Devolve o obxecto de evento en si, o que é conveniente para a chamada en cadea

Cancelar todas as funcións na cola de procesamento de obxectos

1
Object StatsWatcher.off(String ev);

Parámetros de chamada:

  • ev: Cadea, especifica o nome do evento

Resultado de volta:

  • Object, Devolve o obxecto de evento en si, o que é conveniente para a chamada en cadea

Cancelar a función especificada da cola de procesamento de obxectos

1
Object StatsWatcher.off(Object map);

Parámetros de chamada:

  • map: Obxecto, especifique a relación de asignación de eventos, o nome da propiedade do obxecto úsase como nome de evento e o valor da propiedade úsase como función de procesamento de eventos.

Resultado de volta:

  • Object, Devolve o obxecto de evento en si, o que é conveniente para a chamada en cadea

removeListener

Cancelar a función especificada da cola de procesamento de obxectos

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

Parámetros de chamada:

  • ev: Cadea, especifica o nome do evento
  • func: Función, especifica a función de procesamento de eventos

Resultado de volta:

  • Object, Devolve o obxecto de evento en si, o que é conveniente para a chamada en cadea

Cancelar todas as funcións na cola de procesamento de obxectos

1
Object StatsWatcher.removeListener(String ev);

Parámetros de chamada:

  • ev: Cadea, especifica o nome do evento

Resultado de volta:

  • Object, Devolve o obxecto de evento en si, o que é conveniente para a chamada en cadea

Cancelar a función especificada da cola de procesamento de obxectos

1
Object StatsWatcher.removeListener(Object map);

Parámetros de chamada:

  • map: Obxecto, especifique a relación de asignación de eventos, o nome da propiedade do obxecto úsase como nome de evento e o valor da propiedade úsase como función de procesamento de eventos.

Resultado de volta:

  • Object, Devolve o obxecto de evento en si, o que é conveniente para a chamada en cadea

removeAllListeners

Cancelar todos os oíntes de todos os eventos da cola de procesamento de obxectos. Se se especifica un evento, elimine todos os oíntes do evento especificado.

1
Object StatsWatcher.removeAllListeners(String ev);

Parámetros de chamada:

  • ev: Cadea, especifica o nome do evento

Resultado de volta:

  • Object, Devolve o obxecto de evento en si, o que é conveniente para a chamada en cadea

Cancelar todos os oíntes de todos os eventos da cola de procesamento de obxectos. Se se especifica un evento, elimine todos os oíntes do evento especificado.

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

Parámetros de chamada:

  • evs: Array, especifique o nome do evento

Resultado de volta:

  • Object, Devolve o obxecto de evento en si, o que é conveniente para a chamada en cadea

setMaxListeners

O límite predeterminado do número de oíntes, só por compatibilidade

1
StatsWatcher.setMaxListeners(Integer n);

Parámetros de chamada:

  • n: Enteiro, especifique o número de eventos

getMaxListeners

Obtén o límite predeterminado do número de oíntes, só por compatibilidade

1
Integer StatsWatcher.getMaxListeners();

Resultado de volta:

  • Integer, Volver ao número límite predeterminado

listeners

Matriz de oíntes para o evento especificado do obxecto de consulta

1
Array StatsWatcher.listeners(String ev);

Parámetros de chamada:

  • ev: Cadea, especifica o nome do evento

Resultado de volta:

  • Array, Devolve unha matriz de oíntes para o evento especificado

listenerCount

O número de oíntes para o evento especificado do obxecto de consulta

1
Integer StatsWatcher.listenerCount(String ev);

Parámetros de chamada:

  • ev: Cadea, especifica o nome do evento

Resultado de volta:

  • Integer, Devolve o número de oíntes para o evento especificado

eventNames

Consulta o nome do evento do oínte

1
Array StatsWatcher.eventNames();

Resultado de volta:

  • Array, Devolve unha matriz de nomes de eventos

emit

Desencadea un evento activamente

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

Parámetros de chamada:

  • ev: Cadea, nome do evento
  • args: ..., parámetros do evento, que se pasarán ao controlador de eventos

Resultado de volta:

  • Boolean, Volver ao estado de activación do evento, devolver verdadeiro se hai un evento de resposta, en caso contrario devolver falso

toString

Devolve a representación de cadea do obxecto, xeralmente devolve "[Obxecto nativo]", o obxecto pode reimplementarse segundo as súas propias características

1
String StatsWatcher.toString();

Resultado de volta:

  • String, Devolve a representación de cadea do obxecto

toJSON

Devolve a representación en formato JSON do obxecto, xeralmente devolve unha colección de atributos lexibles definidos polo obxecto

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

Parámetros de chamada:

  • key: Cadea, sen usar

Resultado de volta:

  • Value, Devolve un valor que contén JSON serializable