Módulo base del módulo
  1. Inicio
  2. Módulo básico
  3. Módulo fs

Módulo fs

Módulo de procesamiento del sistema de archivos

Cómo utilizar: 

1
var fs = require('fs');

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, especifica la ruta a consultar

Devuelve el resultado:

  • Boolean , devuelve True si el archivo o directorio existe

access

Consulta de permisos de usuario en un archivo especificado 

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

Parámetros de llamada:

  • path : Cadena, especifica la ruta a consultar
  • mode : entero, especifique el permiso de consulta, el valor predeterminado es si el archivo existe

Cree archivos 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, que especifica la ruta a eliminar

mkdir

Crea un directorio 

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

Parámetros de llamada:

  • path : Cadena, especifica el nombre del directorio que se creará
  • mode : entero, especifique 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, especifica el nombre del directorio 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, especifica 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, especifica el nuevo nombre de archivo a modificar

chmod

Establece los permisos de acceso para el archivo especificado. Windows no admite este método. 

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

Parámetros de llamada:

  • path : Cadena, el archivo especificado
  • mode : entero, especifique los derechos de acceso establecidos

lchmod

Establezca el derecho de acceso del archivo especificado. Si el archivo es un enlace suave, el permiso para el archivo no cambia. 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, el archivo especificado
  • mode : entero, especifique los derechos de acceso establecidos

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, el archivo especificado
  • uid : entero, identificación 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, no cambiará el propietario del archivo. 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, el archivo especificado
  • uid : entero, identificación de usuario del propietario del archivo
  • gid : entero, identificación del grupo propietario del archivo

stat

Consultar información básica de un archivo especificado 

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

Parámetros de llamada:

  • path : Cadena, el archivo a consultar

Devuelve el resultado:

  • 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 del enlace suave se devolverá en lugar de la información del archivo señalado. 

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

Parámetros de llamada:

  • path : Cadena, el archivo a consultar

Devuelve el resultado:

  • 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, especifica el archivo de enlace suave para leer

Devuelve el resultado:

  • 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

Devuelve el resultado:

  • String , devuelve la ruta absoluta procesada

Crear archivo de enlace 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 inexistente
  • linkpath : String, el archivo de enlace flexible que se creará
  • type : String, el type de conexión virtual que se creará. Los tipos opcionales son 'file', 'dir', 'junction', y el valor predeterminado es 'file'. Este parámetro solo es válido en Windows. Cuando es 'junction', se creará. La ruta de enlace de la ruta de destino debe ser una ruta absoluta, y el objetivo se convierte 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 fuente, se rellenará con '\ 0', de lo contrario se perderá más del contenido del archivo 

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

Parámetros de llamada:

  • path : Cadena, especifica la ruta del archivo modificado
  • len : Entero, especifique el tamaño del archivo modificado

read

Leer el contenido del archivo basado en el descriptor de 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 : entero, descriptor de archivo
  • buffer : Buffer , el objeto Buffer en el que se escribe el resultado de la lectura
  • offset : entero, offset de escritura de Buffer , el valor predeterminado es 0
  • length : entero, el número de bytes leídos por el 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

Devuelve el resultado:

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

fchmod

Cambie el modo de archivo de acuerdo con el descriptor de archivo. Solo válido en sistemas POSIX. 

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

Parámetros de llamada:

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

fchown

Cambie el propietario según el descriptor de archivo. Solo válido en sistemas POSIX. 

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

Parámetros de llamada:

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

fdatasync

Sincronice los datos con el disco según los descriptores de archivo 

1
static fs.fdatasync(Integer fd) async;

Parámetros de llamada:

  • fd : entero, descriptor de archivo

fsync

Sincronice los datos con el disco según los descriptores de archivo 

1
static fs.fsync(Integer fd) async;

Parámetros de llamada:

  • fd : entero, descriptor de archivo

readdir

Lee la información del archivo del directorio especificado 

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

Parámetros de llamada:

  • path : Cadena, especifique el directorio de la consulta

Devuelve el resultado:

  • NArray , devuelve una matriz de información de archivo para el directorio

openFile

Abrir archivo para leer, escribir o leer y escribir 

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, especifica el método de apertura del archivo, el valor predeterminado es "r", modo de solo lectura

Devuelve el resultado:

Las banderas son compatibles de las siguientes maneras:

  • 'r' Modo de solo lectura. Lanza un error si el archivo no existe.
  • 'r +' Modo de lectura y escritura. Si el archivo no existe, se genera un error.
  • Modo de solo escritura 'w'. El archivo se creará automáticamente si no existe, y se vaciará 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 crea automáticamente si no existe.
  • 'a +' Lectura y escritura en modo agregar, 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, especifica el método de apertura del archivo, el valor predeterminado es "r", modo de solo lectura
  • mode : entero, especifique el modo del archivo al crear el archivo, predeterminado 0666

Devuelve el resultado:

  • Integer , devuelve el descriptor de archivo abierto

Las banderas son compatibles de las siguientes maneras:

  • 'r' Modo de solo lectura. Lanza un error si el archivo no existe.
  • 'r +' Modo de lectura y escritura. Si el archivo no existe, se genera un error.
  • Modo de solo escritura 'w'. El archivo se creará automáticamente si no existe, y se vaciará 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 crea automáticamente si no existe.
  • 'a +' Lectura y escritura en modo agregar, 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 : entero, descriptor de archivo

openTextStream

Abra un archivo de texto para leer, escribir o ambos 

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, especifica el método de apertura del archivo, el valor predeterminado es "r", modo de solo lectura

Devuelve el resultado:

Las banderas son compatibles de las siguientes maneras:

  • 'r' Modo de solo lectura. Lanza un error si el archivo no existe.
  • 'r +' Modo de lectura y escritura. Si el archivo no existe, se genera un error.
  • Modo de solo escritura 'w'. El archivo se creará automáticamente si no existe, y se vaciará 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 crea automáticamente si no existe.
  • 'a +' Lectura y escritura en modo agregar, 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

Devuelve el resultado:

  • 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 : String, especifica el método de decodificación y no decodifica por defecto

Devuelve el resultado:

  • Variant , devuelve el contenido de texto del archivo

readLines

Abra el archivo y lea un conjunto de líneas de texto en una matriz. La identificación de final de línea se basa en la configuración de la propiedad 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 para leer esta vez, predeterminado para leer todas las líneas

Devuelve el resultado:

  • Array , devuelve una matriz de líneas de texto leídas; si no hay datos disponibles o si la conexión se interrumpe, una 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 el contenido 

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

Parámetros de llamada:

  • fname : String, especifique el nombre del archivo
  • data : Buffer , especifica los datos binarios que se escribirán

appendFile

Crea un archivo binario y escribe el contenido 

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

Parámetros de llamada:

  • fname : String, especifique el nombre del archivo
  • data : Buffer , especifica los datos binarios que se escribirán

setZipFS

Configurar 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, todas las memorias caché se borran de forma predeterminada

Propiedad estática

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

modo de búsqueda constante, mover 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 al final del archivo 

1
const fs.SEEK_END = 2;
Copyright © 2014-2019 fibjs.org | Nos apoyan