Módulo módulo básico

Módulo fs

Módulo de procesamiento del sistema de archivos

Instrucciones:

1
var fs = require('fs');

Algunas notas:

  • La ejecución de fs.watch(filename) devolverá un observador heredado de EventEmitter , que admite tres eventos de 'cambio', 'solo cambio' y 'solo nombre'
  • fs.watchFile(target) y fs.unwatchFile(target) todavía se pueden usar en pares
  • fs.watchFile(target) devolverá un objeto StatsWatcher heredado de EventEmitter , llamar a fs.unwatchFile(target) equivalente a llamar a StatsWatcher.close() .

Función estática

exists

Consultar si el archivo o directorio especificado existe

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

Parámetros de llamada:

  • path : Cadena, especifique la ruta a consultar

Resultado devuelto:

  • Boolean , devuelve True para indicar que el archivo o directorio existe

access

Consultar la autoridad del usuario al archivo especificado

1 2
static 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

Crear archivo de enlace duro, este método no es compatible con Windows

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

Parámetros de llamada:

  • oldPath : String, archivo fuente
  • newPath : String, el archivo a crear

Eliminar el archivo especificado

1
static fs.unlink(String path) async;

Parámetros de llamada:

  • path : Cadena, especifique la ruta que se eliminará

mkdir

Crea un directorio

1 2
static 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

1
static fs.rmdir(String path) async;

Parámetros de llamada:

  • path : cadena, especifique el nombre del directorio que se va a eliminar

rename

Renombrar un archivo

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

Parámetros de llamada:

  • from : String, especifique el archivo renombrado
  • to : Cadena, especifique el nuevo nombre de archivo a modificar

copy

Copiar un archivo

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

Parámetros de llamada:

  • from : String, especifique el archivo renombrado
  • to : Cadena, especifique el nuevo nombre de archivo a modificar

chmod

Establezca el permiso de acceso del archivo especificado, Windows no admite este método

1 2
static 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 el permiso de acceso del archivo especificado. Si el archivo es un enlace suave, el permiso para el archivo no cambiará. Solo está disponible en las plataformas de las series macOS y BSD

1 2
static 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

Establece el propietario del archivo especificado, Windows no admite este método

1 2 3
static 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 : entero, identificación del grupo propietario del archivo

lchown

Establezca el propietario del archivo especificado. Si el archivo especificado es un enlace suave, el propietario del archivo señalado no cambiará. Windows no admite este método

1 2 3
static 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 : entero, identificación del grupo propietario del archivo

stat

Consulta la información básica del archivo especificado

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

Parámetros de llamada:

  • path : Cadena, especifique el archivo a consultar

Resultado devuelto:

  • Stat , devuelve la información básica del archivo

lstat

Consulte 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

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

Parámetros de llamada:

  • path : Cadena, especifique el archivo a consultar

Resultado devuelto:

  • Stat , devuelve la información básica del archivo

Lea el archivo de conexión suave especificado, este método no es compatible con Windows

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

Parámetros de llamada:

  • path : Cadena, especifique el archivo de conexión de software que se leerá

Resultado devuelto:

  • String , devuelve el nombre del archivo señalado por el enlace suave

realpath

Devuelve la ruta absoluta de la ruta especificada, si la ruta especificada contiene una ruta relativa, también se expandirá

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

Parámetros de llamada:

  • path : Cadena, especifique la ruta a leer

Resultado devuelto:

  • String , devuelve la ruta absoluta procesada

Crear archivo de conexión suave

1 2 3
static 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 flexible que se creará
  • type : Cadena, el type de conexión flexible 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 'función' La ruta de enlace de la ruta de destino debe ser una ruta absoluta, y el objetivo 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, llénelo con '\ 0', de lo contrario se perderá el contenido del archivo

1 2
static 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 5
static Integer fs.read(Integer fd, Buffer buffer, Integer offset = 0, Integer length = 0, Integer position = -1) async;

Parámetros de llamada:

  • fd : Integer, descriptor de archivo
  • buffer : Buffer , el objeto Buffer en el que se escribe el resultado de la lectura
  • offset : entero, offset de escritura del Buffer , el valor predeterminado es 0
  • length : número entero, el número de bytes leídos del archivo, el valor predeterminado es 0
  • position : Integer, la posición de lectura del archivo, el valor predeterminado es la posición actual del archivo

Resultado devuelto:

  • Integer , el número de bytes realmente leídos

fchmod

Según el descriptor de archivo, cambie el modo de archivo. Solo válido en el sistema POSIX.

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

Parámetros de llamada:

  • fd : Integer, descriptor de archivo
  • mode : entero, el modo del archivo

fchown

Según el descriptor de archivo, cambie el propietario. Solo válido en el sistema POSIX.

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

Parámetros de llamada:

  • fd : Integer, descriptor de archivo
  • uid : entero, ID de usuario
  • gid : entero, id de grupo

fdatasync

Según el descriptor de archivo, sincronice los datos con el disco

1
static fs.fdatasync(Integer fd) async;

Parámetros de llamada:

  • fd : Integer, descriptor de archivo

fsync

Según el descriptor de archivo, sincronice los datos con el disco

1
static fs.fsync(Integer fd) async;

Parámetros de llamada:

  • fd : Integer, descriptor de archivo

readdir

Leer la información del archivo en el directorio especificado

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

Parámetros de llamada:

  • path : Cadena, especifique el directorio que se consultará

Resultado devuelto:

  • NArray , devuelve la matriz de información de archivo del directorio

openFile

Abra el archivo para leer, escribir o leer y escribir simultáneamente

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

Parámetros de llamada:

  • fname : String, especifique el nombre del archivo
  • flags : String, especifique el método de apertura del archivo, el valor predeterminado es "r", solo lectura

Resultado devuelto:

Los métodos admitidos para los indicadores de parámetros son los siguientes:

  • 'r' es de solo lectura, se genera un error si el archivo no existe.
  • Modo de lectura y escritura 'r +', se generará 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 creará automáticamente si no existe.
  • 'a' solo escribe agregar método, el archivo se creará automáticamente si no existe.
  • Método de adición de lectura-escritura 'a +', el archivo se crea automáticamente si no existe.

open

Abrir descriptor de archivo

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

Parámetros de llamada:

  • fname : String, especifique el nombre del archivo
  • flags : String, 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

Resultado devuelto:

  • Integer , devuelve el descriptor de archivo abierto

Los métodos admitidos para los indicadores de parámetros son los siguientes:

  • 'r' es de solo lectura, se genera un error si el archivo no existe.
  • Modo de lectura y escritura 'r +', se genera 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 creará automáticamente si no existe.
  • 'a' solo escribe agregar método, el archivo se creará automáticamente si no existe.
  • Método de adición de lectura-escritura 'a +', el archivo se crea automáticamente si no existe.

close

Cerrar descriptor de archivo

1
static fs.close(Integer fd) async;

Parámetros de llamada:

  • fd : Integer, descriptor de archivo

openTextStream

Abra un archivo de texto para leer, escribir o leer y escribir simultáneamente

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

Parámetros de llamada:

  • fname : String, especifique el nombre del archivo
  • flags : String, especifique el método de apertura del archivo, el valor predeterminado es "r", solo lectura

Resultado devuelto:

Los métodos admitidos para los indicadores de parámetros son los siguientes:

  • 'r' es de solo lectura, se genera un error si el archivo no existe.
  • Modo de lectura y escritura 'r +', se generará 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 creará automáticamente si no existe.
  • 'a' solo escribe agregar método, el archivo se creará automáticamente si no existe.
  • Método de adición de lectura-escritura 'a +', el archivo se crea automáticamente si no existe.

readTextFile

Abra el archivo de texto y lea el contenido.

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

Parámetros de llamada:

  • fname : String, especifique el nombre del archivo

Resultado devuelto:

  • String , devuelve el contenido de texto del archivo

readFile

Abra el archivo binario y lea el contenido.

1 2
static 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

Resultado devuelto:

  • Variant , devuelve el contenido de texto del archivo

readLines

Abra el archivo y lea un conjunto de líneas de texto en una matriz. El final de la línea se basa en la configuración del atributo EOL. Por defecto, posix: "\ n"; windows: "\ r \ n"

1 2
static 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 de forma predeterminada

Resultado devuelto:

  • Array , devuelve la matriz de línea de texto de lectura, 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 2
static fs.writeTextFile(String fname, String txt) async;

Parámetros de llamada:

  • fname : String, especifique el nombre del archivo
  • txt : String, especifique la cadena que se escribirá

writeFile

Crea un archivo binario y escribe contenido

1 2
static 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 2
static 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 2
static fs.setZipFS(String fname, Buffer data);

Parámetros de llamada:

  • fname : String, especifique la ruta de asignación
  • data : Buffer , especifique los datos del archivo zip mapeado

clearZipFS

Borrar zip mapeo de archivos virtuales zip

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

Parámetros de llamada:

  • fname : String, especifique la ruta de asignación, borre todas las memorias caché de forma predeterminada

watch

Observar un archivo y devolver el objeto observador correspondiente.

1
static FSWatcher fs.watch(String fname);

Parámetros de llamada:

  • fname : String, especifique el objeto de archivo a observar

Resultado devuelto:


Observar un archivo y devolver el objeto observador correspondiente.

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

Parámetros de llamada:

  • fname : String, especifique el objeto de archivo a observar
  • callback : Función, (evtType: 'change' | 'rename', filename: string) => any Devolución de llamada de procesamiento cuando cambia el objeto del archivo

Resultado devuelto:


Observar un archivo y devolver el objeto observador correspondiente.

1 2
static 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 el archivo de destino todavía se esté observando
  • options.recursive : {boolean} default: false Para el caso donde fname es una carpeta, si se deben observar todos los subdirectorios debajo de ella de forma recursiva
  • options.encoding : {enum} default: 'utf8' especifica la codificación de caracteres para analizar el fname entrante

Resultado devuelto:


Observar un archivo y devolver el objeto observador correspondiente.

1 2 3
static 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 el archivo de destino todavía se esté observando
  • options.recursive : {boolean} default: false Para el caso donde fname es una carpeta, si se deben observar todos los subdirectorios debajo de ella de forma recursiva
  • options.encoding : {enum} default: '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

Resultado devuelto:


watchFile

Observe un archivo y devuelva el objeto StatsWatcher correspondiente StatsWatcher

1 2
static 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

Resultado devuelto:


Observe un archivo y devuelva el objeto StatsWatcher correspondiente StatsWatcher

1 2 3
static 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 el archivo de destino todavía se esté observando
  • options.recursive : {boolean} default: false Para el caso donde fname es una carpeta, si se deben observar todos los subdirectorios debajo de ella de forma recursiva
  • options.encoding : {enum} default: '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

Resultado devuelto:


unwatchFile

Elimine las devoluciones de llamada de todos los eventos de observación del StatsWatcher que observa fname

1
static fs.unwatchFile(String fname);

Parámetros de llamada:

  • fname : String, especifique el objeto de archivo a observar

Resultado devuelto:


Elimine la callback llamada de la devolución de llamada del evento de observación del StatsWatcher que observa fname

1 2
static 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á

Resultado devuelto:

Incluso si la devolución de llamada ya no está en la devolución de llamada del evento de observación StatsWatcher , no se informará ningún error

Propiedades estáticas

constants

Objeto, objeto constante del módulo fs

1
static readonly Object fs.constants;

constante

SEEK_SET

modo de búsqueda constante, mover a la posición absoluta

1
const fs.SEEK_SET = 0;

SEEK_CUR

El modo de búsqueda constante, moverse a la posición relativa de la posición actual

1
const fs.SEEK_CUR = 1;

SEEK_END

modo de búsqueda constante, muévase a la posición relativa del final del archivo

1
const fs.SEEK_END = 2;