Modul fs

Dateisystem-Verarbeitungsmodul

Anleitung:

1
var fs = require('fs');

Einige Punkte zu beachten:

Run fs.watch(filename)kehrt von einer Vererbung zurückEventEmitter Watcher, es unterstützt "change", "changeonly", "renameonly" drei Ereignisse
fs.watchFile(target)Und fs.unwatchFile(target)kann immer noch paarweise verwendet werden
fs.watchFile(target) Gibt ein geerbtes von zurück EventEmitter von StatsWatcherObjekt, Aufruf fs.unwatchFile(target)gleichbedeutend mit Aufruf StatsWatcher.close().

Statische Funktion

exists

Fragen Sie ab, ob die angegebene Datei oder das angegebene Verzeichnis vorhanden ist

1
static Boolean fs.exists(String path) async;

Parameter aufrufen:

path: String, geben Sie den Pfad an, der abgefragt werden soll

Ergebnis zurückgeben:

Boolean, Gibt True zurück, um anzuzeigen, dass die Datei oder das Verzeichnis vorhanden ist

access

Fragen Sie die Berechtigung des Benutzers nach der angegebenen Datei ab

1
2
static fs.access(String path,
    Integer mode = 0) async;

Parameter aufrufen:

path: String, geben Sie den Pfad an, der abgefragt werden soll
mode: Integer, geben Sie die Abfrageberechtigungen an. Standardmäßig wird angegeben, ob die Datei vorhanden ist

link

Erstellen Sie eine Hardlink-Datei. Diese Methode wird unter Windows nicht unterstützt

1
2
static fs.link(String oldPath,
    String newPath) async;

Parameter aufrufen:

oldPath: String, Quelldatei
newPath: String, die zu erstellende Datei

unlink

Löschen Sie die angegebene Datei

1
static fs.unlink(String path) async;

Parameter aufrufen:

path: String, geben Sie den zu löschenden Pfad an

mkdir

Erstellen Sie ein Verzeichnis

1
2
static fs.mkdir(String path,
    Integer mode = 0777) async;

Parameter aufrufen:

path: String, geben Sie den Namen des zu erstellenden Verzeichnisses an
mode: Ganzzahl, Dateiberechtigungen angeben, Windows ignoriert diesen Parameter

rmdir

Löschen Sie ein Verzeichnis

1
static fs.rmdir(String path) async;

Parameter aufrufen:

path: String, geben Sie den Namen des zu löschenden Verzeichnisses an

rename

Benennen Sie eine Datei um

1
2
static fs.rename(String from,
    String to) async;

Parameter aufrufen:

from: String, geben Sie die umbenannte Datei an
to: String, geben Sie den neuen Dateinamen an, der geändert werden soll

copy

Kopieren Sie eine Datei

1
2
static fs.copy(String from,
    String to) async;

Parameter aufrufen:

from: String, geben Sie die umbenannte Datei an
to: String, geben Sie den neuen Dateinamen an, der geändert werden soll

chmod

Legen Sie die Zugriffsberechtigung für die angegebene Datei fest. Windows unterstützt diese Methode nicht

1
2
static fs.chmod(String path,
    Integer mode) async;

Parameter aufrufen:

path: String, geben Sie die Operationsdatei an
mode: Integer, geben Sie die festgelegte Zugriffsberechtigung an

lchmod

Legen Sie die Zugriffsberechtigung für die angegebene Datei fest. Wenn es sich bei der Datei um einen Softlink handelt, wird die Berechtigung für die Datei nicht geändert. Sie ist nur auf Plattformen der MacOS- und BSD-Serie verfügbar.

1
2
static fs.lchmod(String path,
    Integer mode) async;

Parameter aufrufen:

path: String, geben Sie die Operationsdatei an
mode: Integer, geben Sie die festgelegte Zugriffsberechtigung an

chown

Legen Sie den Eigentümer der angegebenen Datei fest. Windows unterstützt diese Methode nicht

1
2
3
static fs.chown(String path,
    Integer uid,
    Integer gid) async;

Parameter aufrufen:

path: String, die Datei der angegebenen Einstellungen
uid: Integer, die Benutzer-ID des Dateibesitzers
gid: Ganzzahl, Gruppen-ID des Dateieigentümers

lchown

Legen Sie den Eigentümer der angegebenen Datei fest. Wenn es sich bei der angegebenen Datei um einen Softlink handelt, wird der Eigentümer der angegebenen Datei nicht geändert. Windows unterstützt diese Methode nicht

1
2
3
static fs.lchown(String path,
    Integer uid,
    Integer gid) async;

Parameter aufrufen:

path: String, die Datei der angegebenen Einstellungen
uid: Integer, die Benutzer-ID des Dateibesitzers
gid: Ganzzahl, Gruppen-ID des Dateieigentümers

stat

Fragen Sie die Basisinformationen der angegebenen Datei ab

1
static Stat fs.stat(String path) async;

Parameter aufrufen:

path: String, geben Sie die abzufragende Datei an

Ergebnis zurückgeben:

Stat, Geben Sie die grundlegenden Informationen der Datei zurück

lstat

Fragen Sie die Basisinformationen der angegebenen Datei ab. Der Unterschied zu stat besteht darin, dass wannpathWenn es sich um einen Softlink handelt, werden die Informationen des Softlinks anstelle der Informationen der angezeigten Datei zurückgegeben

1
static Stat fs.lstat(String path) async;

Parameter aufrufen:

path: String, geben Sie die abzufragende Datei an

Ergebnis zurückgeben:

Stat, Geben Sie die grundlegenden Informationen der Datei zurück

readlink

Lesen Sie die angegebene Soft-Connection-Datei. Diese Methode wird unter Windows nicht unterstützt

1
static String fs.readlink(String path) async;

Parameter aufrufen:

path: String, geben Sie die zu lesende Soft-Verbindungsdatei an

Ergebnis zurückgeben:

String, Geben Sie den Dateinamen zurück, auf den der Softlink zeigt

realpath

Gibt den absoluten Pfad des angegebenen Pfads zurück. Wenn der angegebene Pfad einen relativen Pfad enthält, wird er ebenfalls erweitert

1
static String fs.realpath(String path) async;

Parameter aufrufen:

path: String, geben Sie den zu lesenden Pfad an

Ergebnis zurückgeben:

String, Geben Sie den verarbeiteten absoluten Pfad zurück

symlink

Erstellen Sie eine weiche Verbindungsdatei

1
2
3
static fs.symlink(String target,
    String linkpath,
    String type = "file") async;

Parameter aufrufen:

target: String, die Zieldatei, bei der es sich um eine Datei, ein Verzeichnis oder einen Pfad handeln kann, der nicht vorhanden ist
linkpath: String, die zu erstellende Softlink-Datei
type: String, der Typ der erstellten Softverbindung, die optionalen Typen sind 'Datei', 'Verzeichnis', 'Junction', der Standardwert ist 'Datei', dieser Parameter ist nur unter Windows gültig, wenn es sich um 'Funktion' handelt, das Ziel wird erstellt Der Pfad-Linkpfad muss ein absoluter Pfad sein, und das Ziel wird automatisch in einen absoluten Pfad konvertiert.

truncate

Ändern Sie die Dateigröße. Wenn die angegebene Länge größer als die Größe der Quelldatei ist, füllen Sie sie mit '\ 0', da sonst mehr Dateiinhalt verloren geht

1
2
static fs.truncate(String path,
    Integer len) async;

Parameter aufrufen:

path: String, geben Sie den Pfad der geänderten Datei an
len: Integer, geben Sie die Größe der geänderten Datei an

read

Lesen Sie gemäß dem Dateideskriptor den Inhalt der Datei

1
2
3
4
5
static Integer fs.read(Integer fd,
    Buffer buffer,
    Integer offset = 0,
    Integer length = 0,
    Integer position = -1) async;

Parameter aufrufen:

fd: Integer, Dateideskriptor
buffer:: BufferLesen Sie das geschriebene Ergebnis Buffer Objekt
offset: Integer, Buffer Schreiboffset, Standard ist 0
length: Integer, die Anzahl der aus der Datei gelesenen Bytes, der Standardwert ist 0
position: Integer, die Position zum Lesen der Datei, die Standardeinstellung ist die aktuelle Position der Datei

Ergebnis zurückgeben:

Integer, Die Anzahl der tatsächlich gelesenen Bytes

fchmod

Entsprechend dem Dateideskriptor wird der Dateimodus geändert. Nur gültig in POSIX-Systemen.

1
2
static fs.fchmod(Integer fd,
    Integer mode) async;

Parameter aufrufen:

fd: Integer, Dateideskriptor
mode: Ganzzahl, Dateimodus

fchown

Entsprechend dem Dateideskriptor wird der Eigentümer geändert. Nur gültig in POSIX-Systemen.

1
2
3
static fs.fchown(Integer fd,
    Integer uid,
    Integer gid) async;

Parameter aufrufen:

fd: Integer, Dateideskriptor
uid: Ganzzahl, Benutzer-ID
gid: Ganzzahl, Gruppen-ID

fdatasync

Synchronisieren Sie die Daten gemäß dem Dateideskriptor mit der Festplatte

1
static fs.fdatasync(Integer fd) async;

Parameter aufrufen:

fd: Integer, Dateideskriptor

fsync

Synchronisieren Sie die Daten gemäß dem Dateideskriptor mit der Festplatte

1
static fs.fsync(Integer fd) async;

Parameter aufrufen:

fd: Integer, Dateideskriptor

readdir

Lesen Sie die Dateiinformationen des angegebenen Verzeichnisses

1
static NArray fs.readdir(String path) async;

Parameter aufrufen:

path: String, geben Sie das Verzeichnis an, das abgefragt werden soll

Ergebnis zurückgeben:

NArray, Gibt das Dateiinformationsarray des Verzeichnisses zurück

openFile

Öffnen Sie die Datei zum gleichzeitigen Lesen, Schreiben oder Lesen und Schreiben

1
2
static SeekableStream fs.openFile(String fname,
    String flags = "r") async;

Parameter aufrufen:

fname: String, geben Sie den Dateinamen an
flags: String, geben Sie die Methode zum Öffnen der Datei an. Die Standardeinstellung ist "r", schreibgeschützt

Ergebnis zurückgeben:

SeekableStream, Geben Sie das geöffnete Dateiobjekt zurück

Folgende Methoden für Parameterflags werden unterstützt:

'r' ist schreibgeschützt. Wenn die Datei nicht vorhanden ist, wird ein Fehler ausgegeben.
Im Lese- und Schreibmodus 'r +' wird ein Fehler ausgegeben, wenn die Datei nicht vorhanden ist.
'w' wird nur geschrieben. Wenn die Datei nicht vorhanden ist, wird sie automatisch erstellt und wenn sie vorhanden ist, wird sie gelöscht.
Im Lese- und Schreibmodus 'w +' wird die Datei automatisch erstellt, wenn sie nicht vorhanden ist.
'a' schreibe nur die Additionsmethode, die Datei wird automatisch erstellt, wenn sie nicht existiert.
'a +' Lese- / Schreib-Additionsmethode, die Datei wird automatisch erstellt, wenn sie nicht existiert.

open

Öffnen Sie den Dateideskriptor

1
2
3
static Integer fs.open(String fname,
    String flags = "r",
    Integer mode = 0666) async;

Parameter aufrufen:

fname: String, geben Sie den Dateinamen an
flags: String, geben Sie die Methode zum Öffnen der Datei an. Die Standardeinstellung ist "r", schreibgeschützt
mode: Integer Geben Sie beim Erstellen einer Datei den Modus der Datei an. Der Standardwert ist 0666

Ergebnis zurückgeben:

Integer, Geben Sie den Deskriptor für geöffnete Dateien zurück

Folgende Methoden für Parameterflags werden unterstützt:

'r' ist schreibgeschützt. Wenn die Datei nicht vorhanden ist, wird ein Fehler ausgegeben.
Im Lese- und Schreibmodus 'r +' wird ein Fehler ausgegeben, wenn die Datei nicht vorhanden ist.
'w' wird nur geschrieben. Wenn die Datei nicht vorhanden ist, wird sie automatisch erstellt und wenn sie vorhanden ist, wird sie gelöscht.
Im Lese- und Schreibmodus 'w +' wird die Datei automatisch erstellt, wenn sie nicht vorhanden ist.
'a' schreibe nur die Additionsmethode, die Datei wird automatisch erstellt, wenn sie nicht existiert.
'a +' Lese- / Schreib-Additionsmethode, die Datei wird automatisch erstellt, wenn sie nicht existiert.

close

Dateideskriptor schließen

1
static fs.close(Integer fd) async;

Parameter aufrufen:

fd: Integer, Dateideskriptor

openTextStream

Öffnen Sie eine Textdatei zum gleichzeitigen Lesen, Schreiben oder Lesen und Schreiben

1
2
static BufferedStream fs.openTextStream(String fname,
    String flags = "r") async;

Parameter aufrufen:

fname: String, geben Sie den Dateinamen an
flags: String, geben Sie die Methode zum Öffnen der Datei an. Die Standardeinstellung ist "r", schreibgeschützt

Ergebnis zurückgeben:

BufferedStream, Geben Sie das geöffnete Dateiobjekt zurück

Folgende Methoden für Parameterflags werden unterstützt:

'r' ist schreibgeschützt. Wenn die Datei nicht vorhanden ist, wird ein Fehler ausgegeben.
Im Lese- und Schreibmodus 'r +' wird ein Fehler ausgegeben, wenn die Datei nicht vorhanden ist.
'w' wird nur geschrieben. Wenn die Datei nicht vorhanden ist, wird sie automatisch erstellt und wenn sie vorhanden ist, wird sie gelöscht.
Im Lese- und Schreibmodus 'w +' wird die Datei automatisch erstellt, wenn sie nicht vorhanden ist.
'a' schreibe nur die Additionsmethode, die Datei wird automatisch erstellt, wenn sie nicht existiert.
'a +' Lese- / Schreib-Additionsmethode, die Datei wird automatisch erstellt, wenn sie nicht existiert.

readTextFile

Öffnen Sie die Textdatei und lesen Sie den Inhalt

1
static String fs.readTextFile(String fname) async;

Parameter aufrufen:

fname: String, geben Sie den Dateinamen an

Ergebnis zurückgeben:

String, Geben Sie den Textinhalt der Datei zurück

readFile

Öffnen Sie die Binärdatei und lesen Sie den Inhalt

1
2
static Variant fs.readFile(String fname,
    String encoding = "") async;

Parameter aufrufen:

fname: String, geben Sie den Dateinamen an
encoding: String, geben Sie die Dekodierungsmethode an. Standardmäßig wird nicht dekodiert

Ergebnis zurückgeben:

Variant, Geben Sie den Textinhalt der Datei zurück

readLines

Öffnen Sie die Datei und lesen Sie eine Reihe von Textzeilen in einem Array. Das Zeilenende wird anhand der Einstellung des EOL-Attributs identifiziert. Standardmäßig ist posix: "\ n"; windows: "\ r \ n"

1
2
static Array fs.readLines(String fname,
    Integer maxlines = -1);

Parameter aufrufen:

fname: String, geben Sie den Dateinamen an
maxlines: Ganzzahl, geben Sie die maximale Anzahl der diesmal gelesenen Zeilen an, lesen Sie standardmäßig alle Textzeilen

Ergebnis zurückgeben:

Array, Gibt das gelesene Textzeilenarray zurück, wenn keine zu lesenden Daten vorhanden sind oder die Verbindung unterbrochen ist, leeres Array

writeTextFile

Erstellen Sie eine Textdatei und schreiben Sie Inhalte

1
2
static fs.writeTextFile(String fname,
    String txt) async;

Parameter aufrufen:

fname: String, geben Sie den Dateinamen an
txt: String, geben Sie den zu schreibenden String an

writeFile

Erstellen Sie eine Binärdatei und schreiben Sie Inhalte

1
2
static fs.writeFile(String fname,
    Buffer data) async;

Parameter aufrufen:

fname: String, geben Sie den Dateinamen an
data:: Buffer, Geben Sie die zu schreibenden Binärdaten an

appendFile

Erstellen Sie eine Binärdatei und schreiben Sie Inhalte

1
2
static fs.appendFile(String fname,
    Buffer data) async;

Parameter aufrufen:

fname: String, geben Sie den Dateinamen an
data:: Buffer, Geben Sie die zu schreibenden Binärdaten an

setZipFS

Installieren zip Zuordnung virtueller Dateien

1
2
static fs.setZipFS(String fname,
    Buffer data);

Parameter aufrufen:

fname: String, geben Sie den Zuordnungspfad an
data:: Buffer, Geben Sie die zugeordnete zip Dateidaten

clearZipFS

klar zip Zuordnung virtueller Dateien

1
static fs.clearZipFS(String fname = "");

Parameter aufrufen:

fname: String, geben Sie den Zuordnungspfad an, löschen Sie standardmäßig alle Caches

watch

Beobachten Sie eine Datei und geben Sie das entsprechende Watcher-Objekt zurück

1
static FSWatcher fs.watch(String fname);

Parameter aufrufen:

fname: String, geben Sie das zu beobachtende Dateiobjekt an

Ergebnis zurückgeben:

FSWatcher, FSWatcher Objekt

Beobachten Sie eine Datei und geben Sie das entsprechende Watcher-Objekt zurück

1
2
static FSWatcher fs.watch(String fname,
    Function callback);

Parameter aufrufen:

fname: String, geben Sie das zu beobachtende Dateiobjekt an
callback: Funktion, (evtType: 'change' | 'rename', filename: string) => anyder Verarbeitungsrückruf, wenn sich das Dateiobjekt ändert

Ergebnis zurückgeben:

FSWatcher, FSWatcher Objekt

Beobachten Sie eine Datei und geben Sie das entsprechende Watcher-Objekt zurück

1
2
static FSWatcher fs.watch(String fname,
    Object options);

Parameter aufrufen:

fname: String, geben Sie das zu beobachtende Dateiobjekt an
options: Objekt, Beobachtungsmöglichkeiten

Ergebnis zurückgeben:

FSWatcher, FSWatcher Objekt

Optionen Folgende Optionen werden unterstützt:

1
2
3
4
5{
    "persistent": true, // {boolean} default: true 是否只要目标文件还在被观察, 进程就不退出
    "recursive": false, // {boolean} default: false 对于 fname 为文件夹的情况, 是否递归地观察其下所有的子目录
    "encoding": "utf8", // {enum} default: 'utf8' 指定解析传入的 fname 的字符编码
}

Beobachten Sie eine Datei und geben Sie das entsprechende Watcher-Objekt zurück

1
2
3
static FSWatcher fs.watch(String fname,
    Object options,
    Function callback);

Parameter aufrufen:

fname: String, geben Sie das zu beobachtende Dateiobjekt an
options: Objekt, Beobachtungsmöglichkeiten
callback: Funktion, (evtType: 'change' | 'rename', filename: string) => anyder Verarbeitungsrückruf, wenn sich das Dateiobjekt ändert

Ergebnis zurückgeben:

FSWatcher, FSWatcher Objekt

Optionen Folgende Optionen werden unterstützt:

1
2
3
4
5{
    "persistent": true, // {boolean} default: true 是否只要目标文件还在被观察, 进程就不退出
    "recursive": false, // {boolean} default: false 对于 fname 为文件夹的情况, 是否递归地观察其下所有的子目录
    "encoding": "utf8", // {enum} default: 'utf8' 指定解析传入的 fname 的字符编码
}

watchFile

Beobachten Sie eine Datei und geben Sie die entsprechende zurück StatsWatcher Objekt

1
2
static StatsWatcher fs.watchFile(String fname,
    Function callback);

Parameter aufrufen:

fname: String, geben Sie das zu beobachtende Dateiobjekt an
callback: Funktion, (curStats: Stats, prevStats: Stats) => anyder Verarbeitungsrückruf, wenn sich die Statistiken des Dateiobjekts ändern

Ergebnis zurückgeben:

StatsWatcher, StatsWatcher Objekt

Beobachten Sie eine Datei und geben Sie die entsprechende zurück StatsWatcher Objekt

1
2
3
static StatsWatcher fs.watchFile(String fname,
    Object options,
    Function callback);

Parameter aufrufen:

fname: String, geben Sie das zu beobachtende Dateiobjekt an
options: Objekt, Beobachtungsmöglichkeiten
callback: Funktion, (curStats: Stats, prevStats: Stats) => anyder Verarbeitungsrückruf, wenn sich die Statistiken des Dateiobjekts ändern

Ergebnis zurückgeben:

StatsWatcher, StatsWatcher Objekt

Optionen Folgende Optionen werden unterstützt:

1
2
3
4
5{
    "persistent": true, // {boolean} default: true 是否只要目标文件还在被观察, 进程就不退出
    "recursive": false, // {boolean} default: false 对于 fname 为文件夹的情况, 是否递归地观察其下所有的子目录
    "encoding": "utf8", // {enum} default: 'utf8' 指定解析传入的 fname 的字符编码
}

unwatchFile

Aus der Beobachtung von fname StatsWatcher Entfernen Sie alle beobachteten Ereignisrückrufe

1
static fs.unwatchFile(String fname);

Parameter aufrufen:

fname: String, geben Sie das zu beobachtende Dateiobjekt an

Ergebnis zurückgeben:

StatsWatcher Objekt

Aus der Beobachtung von fname StatsWatcherDer beobachtete Ereignisrückruf entfernte den callbackRückruf

1
2
static fs.unwatchFile(String fname,
    Function callback);

Parameter aufrufen:

fname: String, geben Sie das zu beobachtende Dateiobjekt an
callback: Funktion, Rückruf muss entfernt werden

Ergebnis zurückgeben:

StatsWatcher Objekt

Auch wenn der Rückruf nicht mehr erfolgt StatsWatcher Beim Rückruf des Beobachtungsereignisses von wird kein Fehler gemeldet

Statische Eigenschaften

constants

Objekt, konstantes Objekt des fs-Moduls

1
static readonly Object fs.constants;

Konstante

SEEK_SET

Suchmodus konstant, in absolute Position bewegen

1
const fs.SEEK_SET = 0;

SEEK_CUR

Die Suchmoduskonstante bewegt sich zur relativen Position der aktuellen Position

1
const fs.SEEK_CUR = 1;

SEEK_END

Suchmoduskonstante, bewegen Sie sich an die relative Position des Dateiende

1
const fs.SEEK_END = 2;

Entwicklungshandbuch

Grundmodul

Eingebaute Objekte

Community-Modul

Modul fs

Statische Funktion

exists

access

link

unlink

mkdir

rmdir

rename

copy

chmod

lchmod

chown

lchown

stat

lstat

readlink

realpath

symlink

truncate

read

fchmod

fchown

fdatasync

fsync

readdir

openFile

open

close

openTextStream

readTextFile

readFile

readLines

writeTextFile

writeFile

appendFile

setZipFS

clearZipFS

watch

watchFile

unwatchFile

Statische Eigenschaften

constants

Konstante

SEEK_SET

SEEK_CUR

SEEK_END