Módulo fs
Módulo de procesamiento del sistema de archivos
Instrucciones:
1var fs = require('fs');
Algunas notas:
- La ejecución de
fs.watch(filename)
devolverá un observador heredado de EventEmitter , que admite tres eventos de 'cambio', 'cambio solo' y 'solo nombre' -
fs.watchFile(target)
yfs.unwatchFile(target)
todavía se pueden usar en pares -
fs.watchFile(target)
devolverá un objeto StatsWatcher heredado de EventEmitter , llamar afs.unwatchFile(target)
equivalente a llamar aStatsWatcher.close()
.
Función estática
exists
Consultar si existe el archivo o directorio especificado
1static Boolean fs.exists(String path) async;
Parámetros de llamada:
- path : Cadena, especifique la ruta a consultar
Devolver resultado:
- Boolean , devuelve True para indicar que el archivo o directorio existe
access
Consultar la autoridad del usuario sobre el archivo especificado
1
2static fs.access(String path,
Integer mode = 0) async;
Parámetros de llamada:
- path : Cadena, especifique la ruta a consultar
- mode : entero, especifique los permisos de consulta, el valor predeterminado es si el archivo existe
link
Cree un archivo de vínculo físico, este método no es compatible con Windows
1
2static fs.link(String oldPath,
String newPath) async;
Parámetros de llamada:
- oldPath : String, archivo fuente
- newPath : String, el archivo que se creará
unlink
Eliminar el archivo especificado
1static fs.unlink(String path) async;
Parámetros de llamada:
- path : Cadena, especifique la ruta a eliminar
mkdir
Crea un directorio
1
2static fs.mkdir(String path,
Integer mode = 0777) async;
Parámetros de llamada:
- path : Cadena, especifique el nombre del directorio que se creará
- mode : entero, especificar permisos de archivo, Windows ignora este parámetro
rmdir
Eliminar un directorio
1static fs.rmdir(String path) async;
Parámetros de llamada:
- path : Cadena, especifique el nombre del directorio que se eliminará
rename
Cambiar el nombre de un archivo
1
2static fs.rename(String from,
String to) async;
Parámetros de llamada:
- from : String, especifique el archivo renombrado
- to : String, especifique el nuevo nombre de archivo a modificar
copy
Copiar un archivo
1
2static fs.copy(String from,
String to) async;
Parámetros de llamada:
- from : String, especifique el archivo renombrado
- to : String, especifique el nuevo nombre de archivo a modificar
chmod
Establezca el permiso de acceso del archivo especificado, Windows no admite este método
1
2static fs.chmod(String path,
Integer mode) async;
Parámetros de llamada:
- path : Cadena, especifique el archivo de operación
- mode : entero, especifique la autoridad de acceso establecida
lchmod
Establezca la autoridad de acceso del archivo especificado. Si el archivo es un enlace flexible, la autoridad sobre el archivo no se cambiará. Solo está disponible en las plataformas de las series macOS y BSD
1
2static fs.lchmod(String path,
Integer mode) async;
Parámetros de llamada:
- path : Cadena, especifique el archivo de operación
- mode : entero, especifique la autoridad de acceso establecida
chown
Establecer el propietario del archivo especificado, Windows no admite este método
1
2
3static fs.chown(String path,
Integer uid,
Integer gid) async;
Parámetros de llamada:
- path : Cadena, especifique el archivo establecido
- uid : entero, ID de usuario del propietario del archivo
- gid : número entero, ID de grupo del propietario del archivo
lchown
Establece el propietario del archivo especificado. Si el archivo especificado es un vínculo suave, el propietario del archivo señalado no se cambiará. Windows no admite este método
1
2
3static fs.lchown(String path,
Integer uid,
Integer gid) async;
Parámetros de llamada:
- path : Cadena, especifique el archivo establecido
- uid : entero, ID de usuario del propietario del archivo
- gid : número entero, ID de grupo del propietario del archivo
stat
Consultar la información básica del archivo especificado
1static Stat fs.stat(String path) async;
Parámetros de llamada:
- path : Cadena, especifique el archivo a consultar
Devolver resultado:
- Stat , devuelve la información básica del archivo
lstat
Consultar la información básica del archivo especificado, a diferencia de stat, cuando la path es un enlace suave, la información devuelta será la información del enlace suave en lugar de la información del archivo señalado
1static Stat fs.lstat(String path) async;
Parámetros de llamada:
- path : Cadena, especifique el archivo a consultar
Devolver resultado:
- Stat , devuelve la información básica del archivo
readlink
Lea el archivo de conexión suave especificado, este método no es compatible con Windows
1static String fs.readlink(String path) async;
Parámetros de llamada:
- path : Cadena, especifique el archivo de conexión suave que se leerá
Devolver resultado:
- String , devuelve el nombre del archivo al que apunta el enlace suave
realpath
Devuelve la ruta absoluta de la ruta especificada, si la ruta especificada contiene una ruta relativa, también se expandirá
1static String fs.realpath(String path) async;
Parámetros de llamada:
- path : Cadena, especifique la ruta para leer
Devolver resultado:
- String , devuelve la ruta absoluta procesada
symlink
Crear archivo de conexión suave
1
2
3static fs.symlink(String target,
String linkpath,
String type = "file") async;
Parámetros de llamada:
- target : String, el archivo de destino, que puede ser un archivo, un directorio o una ruta que no existe
- linkpath : String, el archivo de enlace suave que se creará
- type : Cadena, el type de conexión suave creada, los tipos opcionales son 'archivo', 'dir', 'unión', el valor predeterminado es 'archivo', este parámetro solo es válido en Windows, se creará cuando sea 'unión' La ruta de enlace de la ruta de destino debe ser una ruta absoluta y el destino se convertirá automáticamente en una ruta absoluta.
truncate
Modifique el tamaño del archivo, si la longitud especificada es mayor que el tamaño del archivo de origen, rellénelo con '\ 0', de lo contrario se perderá más contenido del archivo
1
2static fs.truncate(String path,
Integer len) async;
Parámetros de llamada:
- path : Cadena, especifique la ruta del archivo modificado
- len : entero, especifique el tamaño del archivo modificado
read
Según el descriptor del archivo, lea el contenido del archivo
1
2
3
4
5static Integer fs.read(Integer fd,
Buffer buffer,
Integer offset = 0,
Integer length = 0,
Integer position = -1) async;
Parámetros de llamada:
- fd : entero, descriptor de archivo
- buffer : Buffer , el objeto Buffer en el que se escribe el resultado de lectura
- offset : entero, desplazamiento de escritura del Buffer , el valor predeterminado es 0
- length : entero, el número de bytes leídos del archivo, el valor predeterminado es 0
- position : número entero, la posición de lectura del archivo, el valor predeterminado es la posición actual del archivo
Devolver resultado:
- Integer , el número de bytes realmente leídos
fchmod
Según el descriptor de archivo, se cambia el modo de archivo. Solo válido en sistema POSIX.
1
2static fs.fchmod(Integer fd,
Integer mode) async;
Parámetros de llamada:
- fd : entero, descriptor de archivo
- mode : entero, el modo del archivo
fchown
Según el descriptor del archivo, se cambia el propietario. Solo válido en sistema POSIX.
1
2
3static fs.fchown(Integer fd,
Integer uid,
Integer gid) async;
Parámetros de llamada:
- fd : entero, descriptor de archivo
- uid : entero, identificación de usuario
- gid : entero, id de grupo
fdatasync
Según el descriptor de archivo, sincronice los datos en el disco
1static fs.fdatasync(Integer fd) async;
Parámetros de llamada:
- fd : entero, descriptor de archivo
fsync
Según el descriptor de archivo, sincronice los datos en el disco
1static fs.fsync(Integer fd) async;
Parámetros de llamada:
- fd : entero, descriptor de archivo
readdir
Leer la información del archivo en el directorio especificado
1static NArray fs.readdir(String path) async;
Parámetros de llamada:
- path : Cadena, especifique el directorio a consultar
Devolver resultado:
- NArray , devuelve la matriz de información de archivo del directorio
openFile
Abrir archivo para leer, escribir o leer y escribir simultáneamente
1
2static SeekableStream fs.openFile(String fname,
String flags = "r") async;
Parámetros de llamada:
- fname : String, especifique el nombre del archivo
- flags : Cadena, especifique el método de apertura del archivo, el valor predeterminado es "r", solo lectura
Devolver resultado:
- SeekableStream , devuelve el objeto de archivo abierto
Los métodos admitidos de banderas de parámetros son los siguientes:
- 'r' es de solo lectura, se generará un error si el archivo no existe.
- 'r +' modo de lectura y escritura, se producirá un error si el archivo no existe.
- 'w' solo se escribe, el archivo se creará automáticamente si no existe y se borrará si existe.
- Modo de lectura y escritura 'w +', el archivo se crea automáticamente si no existe.
- 'a' solo escribe el método de adición, el archivo se creará automáticamente si no existe.
- 'a +' método de adición de lectura y escritura, el archivo se creará automáticamente si no existe.
open
Descriptor de archivo abierto
1
2
3static Integer fs.open(String fname,
String flags = "r",
Integer mode = 0666) async;
Parámetros de llamada:
- fname : String, especifique el nombre del archivo
- flags : Cadena, especifique el método de apertura del archivo, el valor predeterminado es "r", solo lectura
- mode : entero, al crear un archivo, especifique el modo del archivo, el valor predeterminado es 0666
Devolver resultado:
- Integer , devuelve el descriptor de archivo abierto
Los métodos admitidos de banderas de parámetros son los siguientes:
- 'r' es de solo lectura, se generará un error si el archivo no existe.
- 'r +' modo de lectura y escritura, se producirá un error si el archivo no existe.
- 'w' solo se escribe, el archivo se creará automáticamente si no existe y se borrará si existe.
- Modo de lectura y escritura 'w +', el archivo se crea automáticamente si no existe.
- 'a' solo escribe el método de adición, el archivo se creará automáticamente si no existe.
- 'a +' método de adición de lectura y escritura, el archivo se creará automáticamente si no existe.
close
Cerrar descriptor de archivo
1static fs.close(Integer fd) async;
Parámetros de llamada:
- fd : entero, descriptor de archivo
openTextStream
Abra un archivo de texto para leer, escribir o leer y escribir simultáneamente
1
2static BufferedStream fs.openTextStream(String fname,
String flags = "r") async;
Parámetros de llamada:
- fname : String, especifique el nombre del archivo
- flags : Cadena, especifique el método de apertura del archivo, el valor predeterminado es "r", solo lectura
Devolver resultado:
- BufferedStream , devuelve el objeto de archivo abierto
Los métodos admitidos de banderas de parámetros son los siguientes:
- 'r' es de solo lectura, se generará un error si el archivo no existe.
- 'r +' modo de lectura y escritura, se producirá un error si el archivo no existe.
- 'w' solo se escribe, el archivo se creará automáticamente si no existe y se borrará si existe.
- Modo de lectura y escritura 'w +', el archivo se crea automáticamente si no existe.
- 'a' solo escribe el método de adición, el archivo se creará automáticamente si no existe.
- 'a +' método de adición de lectura y escritura, el archivo se creará automáticamente si no existe.
readTextFile
Abra el archivo de texto y lea el contenido.
1static String fs.readTextFile(String fname) async;
Parámetros de llamada:
- fname : String, especifique el nombre del archivo
Devolver resultado:
- String , devuelve el contenido de texto del archivo.
readFile
Abra el archivo binario y lea el contenido.
1
2static Variant fs.readFile(String fname,
String encoding = "") async;
Parámetros de llamada:
- fname : String, especifique el nombre del archivo
- encoding : Cadena, especifique el método de decodificación, el valor predeterminado es no decodificar
Devolver resultado:
- Variant , devuelve el contenido de texto del archivo.
readLines
Abra el archivo y lea un grupo de líneas de texto en una matriz. El final de la línea se identifica según la configuración del atributo EOL. De forma predeterminada, posix: "\ n"; windows: "\ r \ n"
1
2static Array fs.readLines(String fname,
Integer maxlines = -1);
Parámetros de llamada:
- fname : String, especifique el nombre del archivo
- maxlines : entero, especifique el número máximo de líneas leídas esta vez, lea todas las líneas de texto por defecto
Devolver resultado:
- Array , devuelve la matriz de líneas de texto leído, si no hay datos para leer o la conexión se interrumpe, matriz vacía
writeTextFile
Crea un archivo de texto y escribe contenido
1
2static fs.writeTextFile(String fname,
String txt) async;
Parámetros de llamada:
- fname : String, especifique el nombre del archivo
- txt : Cadena, especifique la cadena que se va a escribir
writeFile
Crea un archivo binario y escribe contenido
1
2static fs.writeFile(String fname,
Buffer data) async;
Parámetros de llamada:
- fname : String, especifique el nombre del archivo
- data : Buffer , especifique los datos binarios que se escribirán
appendFile
Crea un archivo binario y escribe contenido
1
2static fs.appendFile(String fname,
Buffer data) async;
Parámetros de llamada:
- fname : String, especifique el nombre del archivo
- data : Buffer , especifique los datos binarios que se escribirán
setZipFS
Establecer la asignación de archivos virtuales zip
1
2static fs.setZipFS(String fname,
Buffer data);
Parámetros de llamada:
- fname : String, especifique la ruta de mapeo
- data : Buffer , especifique los datos del archivo zip asignado
clearZipFS
zip clara de archivos virtuales zip
1static fs.clearZipFS(String fname = "");
Parámetros de llamada:
- fname : String, especifique la ruta de mapeo, borre todas las cachés por defecto
watch
Observa un archivo y devuelve el objeto de observador correspondiente.
1static FSWatcher fs.watch(String fname);
Parámetros de llamada:
- fname : String, especifique el objeto de archivo a observar
Devolver resultado:
Observa un archivo y devuelve el objeto de observador correspondiente.
1
2static FSWatcher fs.watch(String fname,
Function callback);
Parámetros de llamada:
- fname : String, especifique el objeto de archivo a observar
- callback : Function,
(evtType: 'change' | 'rename', filename: string) => any
devolución de llamada de procesamiento cuando el objeto del archivo cambia
Devolver resultado:
Observa un archivo y devuelve el objeto de observador correspondiente.
1
2static FSWatcher fs.watch(String fname,
Object options);
Parámetros de llamada:
- fname : String, especifique el objeto de archivo a observar
- options : Objeto, opciones de observación
- options.persistent : {boolean} default: true si el proceso no se cerrará mientras se siga observando el archivo de destino
- options.recursive : {boolean} predeterminado: falso Si fname es una carpeta, si se deben observar todos los subdirectorios debajo de ella de forma recursiva
- options.encoding : {enum} predeterminado: 'utf8' especifica la codificación de caracteres para analizar el fname entrante
Devolver resultado:
Observa un archivo y devuelve el objeto de observador correspondiente.
1
2
3static FSWatcher fs.watch(String fname,
Object options,
Function callback);
Parámetros de llamada:
- fname : String, especifique el objeto de archivo a observar
- options : Objeto, opciones de observación
- options.persistent : {boolean} default: true si el proceso no se cerrará mientras se siga observando el archivo de destino
- options.recursive : {boolean} predeterminado: falso Si fname es una carpeta, si se deben observar todos los subdirectorios debajo de ella de forma recursiva
- options.encoding : {enum} predeterminado: 'utf8' especifica la codificación de caracteres para analizar el fname entrante
- callback :
(evtType: 'change' | 'rename', filename: string) => any
devolución de llamada de procesamiento cuando cambia el objeto del archivo
Devolver resultado:
watchFile
Observe un archivo y devuelva el objeto StatsWatcher correspondiente
1
2static StatsWatcher fs.watchFile(String fname,
Function callback);
Parámetros de llamada:
- fname : String, especifique el objeto de archivo a observar
- callback : Function,
(curStats: Stats, prevStats: Stats) => any
devolución de llamada de procesamiento cuando cambian las estadísticas del objeto de archivo
Devolver resultado:
- StatsWatcher , objeto StatsWatcher
Observe un archivo y devuelva el objeto StatsWatcher correspondiente
1
2
3static StatsWatcher fs.watchFile(String fname,
Object options,
Function callback);
Parámetros de llamada:
- fname : String, especifique el objeto de archivo a observar
- options : Objeto, opciones de observación
- options.persistent : {boolean} default: true si el proceso no se cerrará mientras se siga observando el archivo de destino
- options.recursive : {boolean} predeterminado: falso Si fname es una carpeta, si se deben observar todos los subdirectorios debajo de ella de forma recursiva
- options.encoding : {enum} predeterminado: 'utf8' especifica la codificación de caracteres para analizar el fname entrante
- callback :
(curStats: Stats, prevStats: Stats) => any
devolución de llamada de procesamiento cuando cambian las estadísticas del objeto de archivo
Devolver resultado:
- StatsWatcher , objeto StatsWatcher
unwatchFile
Elimine las devoluciones de llamada de todos los eventos de observación de StatsWatcher que observa fname
1static fs.unwatchFile(String fname);
Parámetros de llamada:
- fname : String, especifique el objeto de archivo a observar
Devolver resultado:
- Objeto StatsWatcher
Elimine la callback
llamada de la devolución de llamada del evento de observación de StatsWatcher que observa fname
1
2static fs.unwatchFile(String fname,
Function callback);
Parámetros de llamada:
- fname : String, especifique el objeto de archivo a observar
- callback : función, callback de callback que se eliminará
Devolver resultado:
- Objeto StatsWatcher
Incluso si la devolución de llamada ya no está en la devolución de llamada del evento de observación de StatsWatcher , no se informará ningún error
Propiedades estáticas
constants
Objeto, objeto constante del módulo fs
1static readonly Object fs.constants;
constante
SEEK_SET
modo de búsqueda constante, mover a posición absoluta
1const fs.SEEK_SET = 0;
SEEK_CUR
La constante del modo de búsqueda, se mueve a la posición relativa de la posición actual
1const fs.SEEK_CUR = 1;
SEEK_END
modo de búsqueda constante, moverse a la posición relativa del final del archivo
1const fs.SEEK_END = 2;