LNXSDK/Kha/Backends/Node/js/node/fs/FSWatcher.hx
2025-01-22 16:18:30 +01:00

69 lines
2.2 KiB
Haxe

/*
* Copyright (C)2014-2020 Haxe Foundation
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, including without limitation
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
* DEALINGS IN THE SOFTWARE.
*/
package js.node.fs;
import js.node.Fs.FsPath;
import js.node.events.EventEmitter;
#if haxe4
import js.lib.Error;
#else
import js.Error;
#end
/**
Enumeration of possible types of changes for 'change' event.
**/
@:enum abstract FSWatcherChangeType(String) from String to String {
var Change = "change";
var Rename = "rename";
}
/**
Enumeration of the events emitted by `FSWatcher`.
**/
@:enum abstract FSWatcherEvent<T:haxe.Constraints.Function>(Event<T>) to Event<T> {
/**
Emitted when something changes in a watched directory or file. See more details in `Fs.watch`.
Listener arguments:
event - The type of fs change
filename - The filename that changed (if relevant/available)
**/
var Change:FSWatcherEvent<FSWatcherChangeType->FsPath->Void> = "change";
/**
Emitted when an error occurs.
**/
var Error:FSWatcherEvent<Error->Void> = "error";
}
/**
Objects returned from `Fs.watch` are of this type.
**/
extern class FSWatcher extends EventEmitter<FSWatcher> {
/**
Stop watching for changes on the given `FSWatcher`.
**/
function close():Void;
}