Mòdul fs
Mòdul de processament del sistema de fitxers
Instruccions:
1var fs = require('fs');
Alguns punts a tenir en compte:
- Rendiments d'execució
fs.watch(filename)
d'una herènciaEventEmitter Watcher, admet tres esdeveniments'change ',' changeonly ',' renameonlyly ' fs.watchFile(target)
Ifs.unwatchFile(target)
encara es pot utilitzar per parellesfs.watchFile(target)
Tornarà un heretat de EventEmitter de StatsWatcherObjecte, trucadafs.unwatchFile(target)
equivalent a trucadaStatsWatcher.close()
.- Des de la implementació de Linux,
fs.watch
lesrecursive
opcions win32 / darwin són compatibles amb l'estabilitat. Tot i així, podeu provar d'utilitzar-les només a Linuxfs.watch('/[path](path.md)/to', { recursive: true }, handler)
, però és possible quehandler
el temps de devolució de trucada difereixi de les vostres expectatives.
Objecte
constants
Objecte constant del mòdul fs
1fs_constants fs.constants;
Funció estàtica
exists
Consulteu si existeix el fitxer o el directori especificat
1static Boolean fs.exists(String path) async;
Paràmetres de trucada:
- path: Cadena, especifiqueu el camí a consultar
Resultat de retorn:
- Boolean, Retorna True per indicar que el fitxer o directori existeix
access
Consulteu l'autorització de l'usuari al fitxer especificat
1
2static fs.access(String path,
Integer mode = 0) async;
Paràmetres de trucada:
- path: Cadena, especifiqueu el camí a consultar
- mode: Enter, especifiqueu els permisos de consulta; el valor per defecte és si el fitxer existeix
link
Creeu un fitxer d'enllaç dur, aquest mètode no és compatible amb Windows
1
2static fs.link(String oldPath,
String newPath) async;
Paràmetres de trucada:
- oldPath: Cadena, fitxer font
- newPath: String, el fitxer que cal crear
unlink
Suprimiu el fitxer especificat
1static fs.unlink(String path) async;
Paràmetres de trucada:
- path: Cadena, especifiqueu el camí a suprimir
mkdir
Creeu un directori
1
2static fs.mkdir(String path,
Integer mode = 0777) async;
Paràmetres de trucada:
- path: Cadena, especifiqueu el nom del directori a crear
- mode: Enter, especifiqueu els permisos del fitxer, Windows ignora aquest paràmetre, valor per defecte: 0777
Creeu un directori
1
2static fs.mkdir(String path,
Object opt) async;
Paràmetres de trucada:
- path: Cadena, especifiqueu el nom del directori a crear
- opt: Objecte, especifiqueu paràmetres de creació
El paràmetre de creació pot contenir els valors següents:
1
2
3
4{
recursive: false, // 指定是否父目录不存在是是否自动创建,默认值: false
mode: 0777 // 指定文件权限,Windows 忽略此参数,默认值: 0777
}
rmdir
Suprimiu un directori
1static fs.rmdir(String path) async;
Paràmetres de trucada:
- path: Cadena, especifiqueu el nom del directori a suprimir
rename
Canvieu el nom d'un fitxer
1
2static fs.rename(String from,
String to) async;
Paràmetres de trucada:
- from: Cadena, especifiqueu el fitxer canviat
- to: Cadena, especifiqueu el nou nom del fitxer que voleu modificar
copyFile
Copieu src a dest. Per defecte, si dest ja existeix, se sobreescriurà.
1
2
3static fs.copyFile(String from,
String to,
Integer mode = 0) async;
Paràmetres de trucada:
- from: Cadena, especifiqueu el nom del fitxer font que voleu copiar
- to: Cadena, especifiqueu el nom del fitxer de destinació que voleu copiar
- mode: Enter, especifiqueu el modificador de l'operació de còpia, el valor per defecte és 0
mode és un enter opcional que especifica el comportament de l'operació de còpia. Podeu crear una màscara que consisteixi en OR de bits a bit de dos o més valors (com arafs.constants.COPYFILE_EXCL | fs.constants.COPYFILE_FICLONE).
- fs.constants.COPYFILE_EXCL-Si el dest ja existeix, l'operació de còpia fallarà.
- fs.constants.COPYFILE_FICLONE: l’operació de còpia intentarà crear un enllaç de còpia en escriptura. Si la plataforma no admet la còpia en escriptura, s’utilitzarà un mecanisme de còpia de seguretat.
- fs.constants.COPYFILE_FICLONE_FORCE: l’operació de còpia intentarà crear un enllaç de còpia en escriptura. Si la plataforma no admet la còpia en escriptura, l'operació de còpia fallarà.
chmod
Definiu el permís d'accés al fitxer especificat, Windows no admet aquest mètode
1
2static fs.chmod(String path,
Integer mode) async;
Paràmetres de trucada:
- path: Cadena, especifiqueu el fitxer d'operació
- mode: Enter, especifiqueu l'autoritat d'accés establerta
lchmod
Definiu el permís d'accés al fitxer especificat. Si el fitxer és un enllaç suau, no es canviarà el permís del fitxer. Només està disponible a les plataformes de la sèrie macOS i BSD.
1
2static fs.lchmod(String path,
Integer mode) async;
Paràmetres de trucada:
- path: Cadena, especifiqueu el fitxer d'operació
- mode: Enter, especifiqueu l'autoritat d'accés establerta
chown
Definiu el propietari del fitxer especificat, Windows no admet aquest mètode
1
2
3static fs.chown(String path,
Integer uid,
Integer gid) async;
Paràmetres de trucada:
- path: Cadena, fitxer per especificar la configuració
- uid: Enter, identificador d'usuari del propietari del fitxer
- gid: Enter, identificador de grup de propietari de fitxer
lchown
Definiu el propietari del fitxer especificat. Si el fitxer especificat és un enllaç suau, el propietari del fitxer apuntat no es canviarà. Windows no admet aquest mètode
1
2
3static fs.lchown(String path,
Integer uid,
Integer gid) async;
Paràmetres de trucada:
- path: Cadena, fitxer per especificar la configuració
- uid: Enter, identificador d'usuari del propietari del fitxer
- gid: Enter, identificador de grup de propietari de fitxer
stat
Consulteu la informació bàsica del fitxer especificat
1static Stat fs.stat(String path) async;
Paràmetres de trucada:
- path: Cadena, especifiqueu el fitxer que voleu consultar
Resultat de retorn:
- Stat, Torneu la informació bàsica del fitxer
lstat
Consulteu la informació bàsica del fitxer especificat. La diferència respecte a stat és que quanpathQuan es tracta d'un enllaç suau, es retornarà la informació de l'enllaç suau en lloc de la informació del fitxer apuntat
1static Stat fs.lstat(String path) async;
Paràmetres de trucada:
- path: Cadena, especifiqueu el fitxer que voleu consultar
Resultat de retorn:
- Stat, Torneu la informació bàsica del fitxer
readlink
Llegiu el fitxer de connexió suau especificat, aquest mètode no és compatible amb Windows
1static String fs.readlink(String path) async;
Paràmetres de trucada:
- path: Cadena, especifiqueu el fitxer de connexió suau que voleu llegir
Resultat de retorn:
- String, Torneu el nom del fitxer que assenyala l'enllaç suau
realpath
Retorna el camí d'accés absolut del camí d'accés especificat, si el camí d'accés especificat conté un camí d'accés relatiu, també s'ampliarà
1static String fs.realpath(String path) async;
Paràmetres de trucada:
- path: Cadena, especifiqueu el camí a llegir
Resultat de retorn:
- String, Retorna la ruta absoluta processada
symlink
Crea un fitxer de connexió suau
1
2
3static fs.symlink(String target,
String linkpath,
String type = "file") async;
Paràmetres de trucada:
- target: Cadena, el fitxer de destinació, que pot ser un fitxer, un directori o un camí d'accés que no existeix
- linkpath: Cadena, el fitxer d'enllaç suau que es crearà
- type: Cadena, el tipus de connexió suau creada, els tipus opcionals són "fitxer", "dir", "unió", el valor per defecte és "fitxer", aquest paràmetre només és vàlid a Windows, quan és "conjuntament", l'objectiu es crearà El camí d'enllaç del camí ha de ser un camí d'accés absolut i l'objectiu es convertirà automàticament en un camí d'accés absolut.
truncate
Modifiqueu la mida del fitxer, si la longitud especificada és superior a la mida del fitxer origen, empleneu-lo amb '\ 0'; en cas contrari, es perdrà més contingut del fitxer.
1
2static fs.truncate(String path,
Integer len) async;
Paràmetres de trucada:
- path: Cadena, especifiqueu la ruta del fitxer modificat
- len: Enter, especifiqueu la mida del fitxer modificat
read
Segons el descriptor del fitxer, llegiu el contingut del fitxer
1
2
3
4
5static Integer fs.read(Integer fd,
Buffer buffer,
Integer offset = 0,
Integer length = 0,
Integer position = -1) async;
Paràmetres de trucada:
- fd: Enter, descriptor de fitxers
- buffer: Buffer, Llegiu el resultat escrit Buffer Objecte
- offset: Enter, Buffer Offset d'escriptura, el valor per defecte és 0
- length: Enter, el nombre de bytes llegits del fitxer, el valor per defecte és 0
- position: Enter, la posició de lectura del fitxer, per defecte és la posició actual del fitxer
Resultat de retorn:
- Integer, El nombre de bytes realment llegits
fchmod
Segons el descriptor de fitxers, es canvia el mode de fitxer. Només vàlid en sistemes POSIX.
1
2static fs.fchmod(Integer fd,
Integer mode) async;
Paràmetres de trucada:
- fd: Enter, descriptor de fitxers
- mode: Enter, mode fitxer
fchown
Segons el descriptor del fitxer, es canvia el propietari. Només vàlid en sistemes POSIX.
1
2
3static fs.fchown(Integer fd,
Integer uid,
Integer gid) async;
Paràmetres de trucada:
- fd: Enter, descriptor de fitxers
- uid: Enter, identificador d'usuari
- gid: Enter, identificador de grup
fdatasync
Segons el descriptor de fitxers, sincronitzeu les dades amb el disc
1static fs.fdatasync(Integer fd) async;
Paràmetres de trucada:
- fd: Enter, descriptor de fitxers
fsync
Segons el descriptor de fitxers, sincronitzeu les dades amb el disc
1static fs.fsync(Integer fd) async;
Paràmetres de trucada:
- fd: Enter, descriptor de fitxers
readdir
Llegiu la informació del fitxer del directori especificat
1static NArray fs.readdir(String path) async;
Paràmetres de trucada:
- path: Cadena, especifiqueu el directori a consultar
Resultat de retorn:
- NArray, Retorna la matriu d'informació del fitxer del directori
openFile
Obriu el fitxer per llegir, escriure o llegir i escriure alhora
1
2static SeekableStream fs.openFile(String fname,
String flags = "r") async;
Paràmetres de trucada:
- fname: Cadena, especifiqueu el nom del fitxer
- flags: Cadena, especifiqueu el mètode d'obertura del fitxer, el valor per defecte és "r", només de lectura
Resultat de retorn:
- SeekableStream, Retorna l'objecte de fitxer obert
Els mètodes compatibles amb els indicadors de paràmetres són els següents:
- 'r' és de només lectura, es produirà un error si el fitxer no existeix.
- En mode de lectura i escriptura 'r +', es produirà un error si el fitxer no existeix.
- "w" només s'escriu. Si el fitxer no existeix, es crearà automàticament i, si existeix, s'esborrarà.
- En mode de lectura i escriptura 'w +', el fitxer es crearà automàticament si no existeix.
- 'a' només escriu el mètode d'addició, el fitxer es crearà automàticament si no existeix.
- "un +" mètode d'addició de lectura i escriptura, el fitxer es crearà automàticament si no existeix.
open
Obre el descriptor de fitxers
1
2
3static Integer fs.open(String fname,
String flags = "r",
Integer mode = 0666) async;
Paràmetres de trucada:
- fname: Cadena, especifiqueu el nom del fitxer
- flags: Cadena, especifiqueu el mètode d'obertura del fitxer, el valor per defecte és "r", només de lectura
- mode: Enter, quan creeu un fitxer, especifiqueu el mode del fitxer, el valor per defecte és 0666
Resultat de retorn:
- Integer, Torneu el descriptor de fitxer obert
Els mètodes compatibles amb els indicadors de paràmetres són els següents:
- 'r' és de només lectura, es produirà un error si el fitxer no existeix.
- En mode de lectura i escriptura 'r +', es produirà un error si el fitxer no existeix.
- "w" només s'escriu. Si el fitxer no existeix, es crearà automàticament i, si existeix, s'esborrarà.
- En mode de lectura i escriptura 'w +', el fitxer es crearà automàticament si no existeix.
- 'a' només escriu el mètode d'addició, el fitxer es crearà automàticament si no existeix.
- "un +" mètode d'addició de lectura i escriptura, el fitxer es crearà automàticament si no existeix.
close
Tanca el descriptor de fitxers
1static fs.close(Integer fd) async;
Paràmetres de trucada:
- fd: Enter, descriptor de fitxers
openTextStream
Obriu un fitxer de text per llegir, escriure o llegir i escriure alhora
1
2static BufferedStream fs.openTextStream(String fname,
String flags = "r") async;
Paràmetres de trucada:
- fname: Cadena, especifiqueu el nom del fitxer
- flags: Cadena, especifiqueu el mètode d'obertura del fitxer, el valor per defecte és "r", només de lectura
Resultat de retorn:
- BufferedStream, Retorna l'objecte de fitxer obert
Els mètodes compatibles amb els indicadors de paràmetres són els següents:
- 'r' és de només lectura, es produirà un error si el fitxer no existeix.
- En mode de lectura i escriptura 'r +', es produirà un error si el fitxer no existeix.
- "w" només s'escriu. Si el fitxer no existeix, es crearà automàticament i, si existeix, s'esborrarà.
- En mode de lectura i escriptura 'w +', el fitxer es crearà automàticament si no existeix.
- 'a' només escriu el mètode d'addició, el fitxer es crearà automàticament si no existeix.
- "un +" mètode d'addició de lectura i escriptura, el fitxer es crearà automàticament si no existeix.
readTextFile
Obriu el fitxer de text i llegiu el contingut
1static String fs.readTextFile(String fname) async;
Paràmetres de trucada:
- fname: Cadena, especifiqueu el nom del fitxer
Resultat de retorn:
- String, Retorna el contingut de text del fitxer
readFile
Obriu el fitxer binari i llegiu el contingut
1
2static Variant fs.readFile(String fname,
String encoding = "") async;
Paràmetres de trucada:
- fname: Cadena, especifiqueu el nom del fitxer
- encoding: Cadena, especifiqueu el mètode de descodificació; el valor per defecte no és descodificar
Resultat de retorn:
- Variant, Retorna el contingut de text del fitxer
readLines
Obriu el fitxer i llegiu un grup de línies de text en una matriu. El final de la línia s'identifica segons la configuració de l'atribut EOL. Per defecte, posix: "\ n"; windows: "\ r \ n"
1
2static Array fs.readLines(String fname,
Integer maxlines = -1);
Paràmetres de trucada:
- fname: Cadena, especifiqueu el nom del fitxer
- maxlines: Enter, especifiqueu el nombre màxim de línies llegides aquesta vegada, llegiu totes les línies de text per defecte
Resultat de retorn:
- Array, Retorna la matriu de línia de text llegida, si no hi ha dades per llegir o la connexió està interrompuda, matriu buida
writeTextFile
Creeu un fitxer de text i escriviu contingut
1
2static fs.writeTextFile(String fname,
String txt) async;
Paràmetres de trucada:
- fname: Cadena, especifiqueu el nom del fitxer
- txt: Cadena, especifiqueu la cadena que cal escriure
writeFile
Creeu un fitxer binari i escriviu contingut
1
2static fs.writeFile(String fname,
Buffer data) async;
Paràmetres de trucada:
- fname: Cadena, especifiqueu el nom del fitxer
- data: Buffer, Especifiqueu les dades binàries que cal escriure
appendFile
Creeu un fitxer binari i escriviu contingut
1
2static fs.appendFile(String fname,
Buffer data) async;
Paràmetres de trucada:
- fname: Cadena, especifiqueu el nom del fitxer
- data: Buffer, Especifiqueu les dades binàries que cal escriure
setZipFS
configurar zip Assignació de fitxers virtuals
1
2static fs.setZipFS(String fname,
Buffer data);
Paràmetres de trucada:
- fname: Cadena, especifiqueu el camí de mapatge
- data: Buffer, Especifiqueu el mapa assignat zip Dades de fitxers
clearZipFS
Clar zip Assignació de fitxers virtuals
1static fs.clearZipFS(String fname = "");
Paràmetres de trucada:
- fname: Cadena, especifiqueu el camí de mapatge, esborreu totes les memòries cau per defecte
watch
Observeu un fitxer i torneu l'objecte de vigilància corresponent
1static FSWatcher fs.watch(String fname);
Paràmetres de trucada:
- fname: Cadena, especifiqueu l'objecte de fitxer que cal observar
Resultat de retorn:
Observeu un fitxer i torneu l'objecte de vigilància corresponent
1
2static FSWatcher fs.watch(String fname,
Function callback);
Paràmetres de trucada:
- fname: Cadena, especifiqueu l'objecte de fitxer que cal observar
- callback: Funció,
(evtType: 'change' | 'rename', filename: string) => any
la devolució de trucada de processament quan canvia l'objecte del fitxer
Resultat de retorn:
Observeu un fitxer i torneu l'objecte de vigilància corresponent
1
2static FSWatcher fs.watch(String fname,
Object options);
Paràmetres de trucada:
- fname: Cadena, especifiqueu l'objecte de fitxer que cal observar
- options: Objecte, opcions d’observació
Resultat de retorn:
Les opcions compatibles són les següents:
1
2
3
4
5{
"persistent": true, // {boolean} default: true 是否只要目标文件还在被观察, 进程就不退出
"recursive": false, // {boolean} default: false 对于 fname 为文件夹的情况, 是否递归地观察其下所有的子目录
"encoding": "utf8", // {enum} default: 'utf8' 指定解析传入的 fname 的字符编码
}
Observeu un fitxer i torneu l'objecte de vigilància corresponent
1
2
3static FSWatcher fs.watch(String fname,
Object options,
Function callback);
Paràmetres de trucada:
- fname: Cadena, especifiqueu l'objecte de fitxer que cal observar
- options: Objecte, opcions d’observació
- callback: Funció,
(evtType: 'change' | 'rename', filename: string) => any
la devolució de trucada de processament quan canvia l'objecte del fitxer
Resultat de retorn:
Les opcions compatibles són les següents:
1
2
3
4
5{
"persistent": true, // {boolean} default: true 是否只要目标文件还在被观察, 进程就不退出
"recursive": false, // {boolean} default: false 对于 fname 为文件夹的情况, 是否递归地观察其下所有的子目录
"encoding": "utf8", // {enum} default: 'utf8' 指定解析传入的 fname 的字符编码
}
watchFile
Observeu un fitxer i torneu-ne el corresponent StatsWatcher Objecte
1
2static StatsWatcher fs.watchFile(String fname,
Function callback);
Paràmetres de trucada:
- fname: Cadena, especifiqueu l'objecte de fitxer que cal observar
- callback: Funció,
(curStats: Stats, prevStats: Stats) => any
la devolució de trucada de processament quan canvien les estadístiques de l'objecte de fitxer
Resultat de retorn:
- StatsWatcher, StatsWatcher Objecte
Observeu un fitxer i torneu-ne el corresponent StatsWatcher Objecte
1
2
3static StatsWatcher fs.watchFile(String fname,
Object options,
Function callback);
Paràmetres de trucada:
- fname: Cadena, especifiqueu l'objecte de fitxer que cal observar
- options: Objecte, opcions d’observació
- callback: Funció,
(curStats: Stats, prevStats: Stats) => any
la devolució de trucada de processament quan canvien les estadístiques de l'objecte de fitxer
Resultat de retorn:
- StatsWatcher, StatsWatcher Objecte
Les opcions compatibles són les següents:
1
2
3
4
5{
"persistent": true, // {boolean} default: true 是否只要目标文件还在被观察, 进程就不退出
"recursive": false, // {boolean} default: false 对于 fname 为文件夹的情况, 是否递归地观察其下所有的子目录
"encoding": "utf8", // {enum} default: 'utf8' 指定解析传入的 fname 的字符编码
}
unwatchFile
A partir de l'observació de fname StatsWatcher Elimineu tots els esdeveniments observats a la devolució de trucada
1static fs.unwatchFile(String fname);
Paràmetres de trucada:
- fname: Cadena, especifiqueu l'objecte de fitxer que cal observar
Resultat de retorn:
- StatsWatcher Objecte
A partir de l'observació de fname StatsWatcherLa devolució de trucada de l'esdeveniment observat ha eliminat la callback
devolució de trucada
1
2static fs.unwatchFile(String fname,
Function callback);
Paràmetres de trucada:
- fname: Cadena, especifiqueu l'objecte de fitxer que cal observar
- callback: Funció, eliminació de devolució de trucada
Resultat de retorn:
- StatsWatcher Objecte
Fins i tot si la devolució de trucada ja no és StatsWatcher No es notificarà cap error en la devolució de trucada de l’esdeveniment d’observació
constant
SEEK_SET
mode de cerca constant, passa a la posició absoluta
1const fs.SEEK_SET = 0;
SEEK_CUR
La constant de mode de cerca, es mou a la posició relativa de la posició actual
1const fs.SEEK_CUR = 1;
SEEK_END
constant de mode de cerca, moveu-vos a la posició relativa del final del fitxer
1const fs.SEEK_END = 2;