Object StatsWatcher
File Stats Observed Object
When the call fs.watchFile(target, onchange)
is successful, the return type of object
1
2
3
4
5
6
7var fs = require("fs");
var statsWatcher = fs.watchFile(target, (curStat, prevStat) => {
// process
// ...
statsWatcher.unref();
});
Note that the onchange callback will be triggered when and only when the mtime attribute of the observed target file target changes
Simply accessing the target file target will not trigger the onchange callback.
If you call fs.watchFile(target)
, the file or directory target represented did not exist, then onchange callback will not be called until the target is created, the callback will start to be called. If the work en route watcher,) the target file is deleted, No more callbacks will be generated in the future
Inheritance
Static properties
defaultMaxListeners
Integer, the default global maximum number of listeners
1static Integer StatsWatcher.defaultMaxListeners;
Member attributes
onchange
Function, query and bind "file change" event, equivalent to on("change", func);
1Function StatsWatcher.onchange;
Member function
close
Stop observing the target file path and clear the reference count (no longer hold the process)
1StatsWatcher.close();
ref
Increase the reference count, tell fibjs not to exit the process as long as the watcher is still in use,
1StatsWatcher StatsWatcher.ref();
Return result:
- StatsWatcher, Return StatsWatcher itself
Through the fs.watchFile()
resulting StatsWatcher default has been called the method, the default will hold process.
unref
Decrease the reference count
1StatsWatcher StatsWatcher.unref();
Return result:
- StatsWatcher, Return StatsWatcher itself
on
Bind an event handler to the object
1
2Object StatsWatcher.on(String ev,
Function func);
Call parameters:
- ev: String, specify the name of the event
- func: Function, specify event processing function
Return result:
- Object, Return the event object itself, which is convenient for chain call
Bind an event handler to the object
1Object StatsWatcher.on(Object map);
Call parameters:
- map: Object, specify the event mapping relationship, the object property name will be used as the event name, and the property value will be used as the event processing function
Return result:
- Object, Return the event object itself, which is convenient for chain call
addListener
Bind an event handler to the object
1
2Object StatsWatcher.addListener(String ev,
Function func);
Call parameters:
- ev: String, specify the name of the event
- func: Function, specify event processing function
Return result:
- Object, Return the event object itself, which is convenient for chain call
Bind an event handler to the object
1Object StatsWatcher.addListener(Object map);
Call parameters:
- map: Object, specify the event mapping relationship, the object property name will be used as the event name, and the property value will be used as the event processing function
Return result:
- Object, Return the event object itself, which is convenient for chain call
prependListener
Bind an event handler to the start of the object
1
2Object StatsWatcher.prependListener(String ev,
Function func);
Call parameters:
- ev: String, specify the name of the event
- func: Function, specify event processing function
Return result:
- Object, Return the event object itself, which is convenient for chain call
Bind an event handler to the start of the object
1Object StatsWatcher.prependListener(Object map);
Call parameters:
- map: Object, specify the event mapping relationship, the object property name will be used as the event name, and the property value will be used as the event processing function
Return result:
- Object, Return the event object itself, which is convenient for chain call
once
Bind a one-time event processing function to the object, the one-time processing function will only be triggered once
1
2Object StatsWatcher.once(String ev,
Function func);
Call parameters:
- ev: String, specify the name of the event
- func: Function, specify event processing function
Return result:
- Object, Return the event object itself, which is convenient for chain call
Bind a one-time event processing function to the object, the one-time processing function will only be triggered once
1Object StatsWatcher.once(Object map);
Call parameters:
- map: Object, specify the event mapping relationship, the object property name will be used as the event name, and the property value will be used as the event processing function
Return result:
- Object, Return the event object itself, which is convenient for chain call
prependOnceListener
Bind an event handler to the start of the object
1
2Object StatsWatcher.prependOnceListener(String ev,
Function func);
Call parameters:
- ev: String, specify the name of the event
- func: Function, specify event processing function
Return result:
- Object, Return the event object itself, which is convenient for chain call
Bind an event handler to the start of the object
1Object StatsWatcher.prependOnceListener(Object map);
Call parameters:
- map: Object, specify the event mapping relationship, the object property name will be used as the event name, and the property value will be used as the event processing function
Return result:
- Object, Return the event object itself, which is convenient for chain call
off
Cancel the specified function from the object processing queue
1
2Object StatsWatcher.off(String ev,
Function func);
Call parameters:
- ev: String, specify the name of the event
- func: Function, specify event processing function
Return result:
- Object, Return the event object itself, which is convenient for chain call
Cancel all functions in the object processing queue
1Object StatsWatcher.off(String ev);
Call parameters:
- ev: String, specify the name of the event
Return result:
- Object, Return the event object itself, which is convenient for chain call
Cancel the specified function from the object processing queue
1Object StatsWatcher.off(Object map);
Call parameters:
- map: Object, specify the event mapping relationship, the object property name is used as the event name, and the property value is used as the event processing function
Return result:
- Object, Return the event object itself, which is convenient for chain call
removeListener
Cancel the specified function from the object processing queue
1
2Object StatsWatcher.removeListener(String ev,
Function func);
Call parameters:
- ev: String, specify the name of the event
- func: Function, specify event processing function
Return result:
- Object, Return the event object itself, which is convenient for chain call
Cancel all functions in the object processing queue
1Object StatsWatcher.removeListener(String ev);
Call parameters:
- ev: String, specify the name of the event
Return result:
- Object, Return the event object itself, which is convenient for chain call
Cancel the specified function from the object processing queue
1Object StatsWatcher.removeListener(Object map);
Call parameters:
- map: Object, specify the event mapping relationship, the object property name is used as the event name, and the property value is used as the event processing function
Return result:
- Object, Return the event object itself, which is convenient for chain call
removeAllListeners
Cancel all the listeners of all events from the object processing queue. If an event is specified, remove all the listeners of the specified event.
1Object StatsWatcher.removeAllListeners(String ev);
Call parameters:
- ev: String, specify the name of the event
Return result:
- Object, Return the event object itself, which is convenient for chain call
Cancel all the listeners of all events from the object processing queue. If an event is specified, remove all the listeners of the specified event.
1Object StatsWatcher.removeAllListeners(Array evs = []);
Call parameters:
- evs: Array, specify the name of the event
Return result:
- Object, Return the event object itself, which is convenient for chain call
setMaxListeners
The default limit of the number of listeners, only for compatibility
1StatsWatcher.setMaxListeners(Integer n);
Call parameters:
- n: Integer, specify the number of events
getMaxListeners
Get the default limit of the number of listeners, only for compatibility
1Integer StatsWatcher.getMaxListeners();
Return result:
- Integer, Return to the default limit number
listeners
Array of listeners for the specified event of the query object
1Array StatsWatcher.listeners(String ev);
Call parameters:
- ev: String, specify the name of the event
Return result:
- Array, Returns an array of listeners for the specified event
listenerCount
The number of listeners for the specified event of the query object
1Integer StatsWatcher.listenerCount(String ev);
Call parameters:
- ev: String, specify the name of the event
Return result:
- Integer, Returns the number of listeners for the specified event
The number of listeners for the specified event of the query object
1
2Integer StatsWatcher.listenerCount(Value o,
String ev);
Call parameters:
- o: Value, specify the object of the query
- ev: String, specify the name of the event
Return result:
- Integer, Returns the number of listeners for the specified event
eventNames
Query the event name of the listener
1Array StatsWatcher.eventNames();
Return result:
- Array, Returns an array of event names
emit
Trigger an event actively
1
2Boolean StatsWatcher.emit(String ev,
...args);
Call parameters:
- ev: String, event name
- args: ..., event parameters, which will be passed to the event handler
Return result:
- Boolean, Return to the event trigger state, return true if there is a response event, otherwise return false
toString
Returns the string representation of the object, generally returns "[Native Object]", the object can be re-implemented according to its own characteristics
1String StatsWatcher.toString();
Return result:
- String, Returns the string representation of the object
toJSON
Returns the JSON format representation of the object, generally returns a collection of readable attributes defined by the object
1Value StatsWatcher.toJSON(String key = "");
Call parameters:
- key: String, unused
Return result:
- Value, Returns a value containing JSON serializable