Modulo modulo base

Modulo fs

Modulo di elaborazione del file system

Istruzioni:

1
var fs = require('fs');

Alcune note:

  • L'esecuzione di fs.watch(filename) restituirà un watcher ereditato da EventEmitter , che supporta tre eventi di "change", "changeonly" e "renameonly "
  • fs.watchFile(target) e fs.unwatchFile(target) possono ancora essere utilizzati in coppia
  • fs.watchFile(target) restituirà un oggetto StatsWatcher ereditato da EventEmitter , chiamare fs.unwatchFile(target) equivale a chiamare StatsWatcher.close() .

Funzione statica

exists

Interroga se il file o la directory specificati esiste

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

Parametri di chiamata:

  • path : stringa, specifica il percorso da interrogare

Risultato di ritorno:

  • Boolean , restituisce True per indicare che il file o la directory esiste

access

Interroga l'autorizzazione dell'utente sul file specificato

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

Parametri di chiamata:

  • path : stringa, specifica il percorso da interrogare
  • mode : numero intero, specifica le autorizzazioni della query, l'impostazione predefinita è se il file esiste

Crea file hard link, questo metodo non è supportato in Windows

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

Parametri di chiamata:

  • oldPath : String, file di origine
  • newPath : String, il file da creare

Elimina il file specificato

1
static fs.unlink(String path) async;

Parametri di chiamata:

  • path : stringa, specifica il percorso da eliminare

mkdir

Crea una directory

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

Parametri di chiamata:

  • path : stringa, specificare il nome della directory da creare
  • mode : numero intero, specificare i permessi del file, Windows ignora questo parametro

rmdir

Elimina una directory

1
static fs.rmdir(String path) async;

Parametri di chiamata:

  • path : stringa, specificare il nome della directory da eliminare

rename

Rinomina un file

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

Parametri di chiamata:

  • from : String, specifica il file rinominato
  • to : String, specificare il nuovo nome file da modificare

copy

Copia un file

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

Parametri di chiamata:

  • from : String, specifica il file rinominato
  • to : String, specificare il nuovo nome file da modificare

chmod

Imposta l'autorizzazione di accesso del file specificato, Windows non supporta questo metodo

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

Parametri di chiamata:

  • path : stringa, specifica il file dell'operazione
  • mode : numero intero, specificare l'autorità di accesso impostata

lchmod

Imposta l'autorità di accesso del file specificato. Se il file è un collegamento software, l'autorizzazione al file non verrà modificata. È disponibile solo su piattaforme della serie macOS e BSD

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

Parametri di chiamata:

  • path : stringa, specifica il file dell'operazione
  • mode : numero intero, specificare l'autorità di accesso impostata

chown

Imposta il proprietario del file specificato, Windows non supporta questo metodo

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

Parametri di chiamata:

  • path : stringa, specifica il file impostato
  • uid : numero intero, ID utente del proprietario del file
  • gid : numero intero, ID gruppo proprietario del file

lchown

Imposta il proprietario del file specificato. Se il file specificato è un collegamento software, il proprietario del file puntato non verrà modificato. Windows non supporta questo metodo

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

Parametri di chiamata:

  • path : stringa, specifica il file impostato
  • uid : numero intero, ID utente del proprietario del file
  • gid : numero intero, ID gruppo proprietario del file

stat

Interroga le informazioni di base del file specificato

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

Parametri di chiamata:

  • path : stringa, specifica il file da interrogare

Risultato di ritorno:

  • Stat , restituisce le informazioni di base del file

lstat

Interroga le informazioni di base del file specificato, a differenza di stat, quando il path è un soft link, le informazioni restituite saranno le informazioni del soft link invece delle informazioni del file puntato

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

Parametri di chiamata:

  • path : stringa, specifica il file da interrogare

Risultato di ritorno:

  • Stat , restituisce le informazioni di base del file

Leggi il file di connessione software specificato, questo metodo non è supportato in Windows

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

Parametri di chiamata:

  • path : stringa, specifica il file di connessione software da leggere

Risultato di ritorno:

  • String , restituisce il nome del file a cui punta il collegamento software

realpath

Restituisce il percorso assoluto del percorso specificato, se il percorso specificato contiene un percorso relativo, verrà anche espanso

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

Parametri di chiamata:

  • path : stringa, specifica il percorso da leggere

Risultato di ritorno:

  • String , restituisce il percorso assoluto elaborato

Crea file di connessione soft

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

Parametri di chiamata:

  • target : String, il file di destinazione, che può essere un file, una directory o un percorso che non esiste
  • linkpath : String, il file di collegamento software da creare
  • type : String, il type di connessione soft creata, i tipi opzionali sono "file", "dir", "junction", il valore predefinito è "file", questo parametro è valido solo su Windows, verrà creato quando è "giunzione" Il percorso di destinazione linkpath deve essere un percorso assoluto e la destinazione verrà convertita automaticamente in un percorso assoluto.

truncate

Modifica la dimensione del file, se la lunghezza specificata è maggiore della dimensione del file sorgente, riempila con '\ 0', altrimenti il ​​contenuto del file andrà perso

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

Parametri di chiamata:

  • path : stringa, specifica il percorso del file modificato
  • len : numero intero, specifica la dimensione del file modificato

read

Secondo il descrittore di file, leggi il contenuto del file

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

Parametri di chiamata:

  • fd : intero, descrittore di file
  • buffer : Buffer , l'oggetto Buffer in cui viene scritto il risultato della lettura
  • offset : numero intero, offset di scrittura nel Buffer , il valore predefinito è 0
  • length : Integer, il numero di byte letti dal file, il valore predefinito è 0
  • position : numero intero, la posizione di lettura del file, l'impostazione predefinita è la posizione del file corrente

Risultato di ritorno:

  • Integer , il numero di byte effettivamente letti

fchmod

Secondo il descrittore di file, cambia la modalità del file. Valido solo nel sistema POSIX.

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

Parametri di chiamata:

  • fd : intero, descrittore di file
  • mode : Integer, la modalità del file

fchown

Secondo il descrittore di file, il proprietario viene modificato. Valido solo nel sistema POSIX.

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

Parametri di chiamata:

  • fd : intero, descrittore di file
  • uid : numero intero, ID utente
  • gid : numero intero, ID gruppo

fdatasync

Secondo il descrittore di file, sincronizza i dati su disco

1
static fs.fdatasync(Integer fd) async;

Parametri di chiamata:

  • fd : intero, descrittore di file

fsync

Secondo il descrittore di file, sincronizza i dati su disco

1
static fs.fsync(Integer fd) async;

Parametri di chiamata:

  • fd : intero, descrittore di file

readdir

Leggi le informazioni sul file nella directory specificata

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

Parametri di chiamata:

  • path : stringa, specifica la directory da interrogare

Risultato di ritorno:

  • NArray , restituisce la matrice delle informazioni sui file della directory

openFile

Apri file per lettura, scrittura o lettura e scrittura simultanee

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

Parametri di chiamata:

  • fname : String, specifica il nome del file
  • flags : String, specifica il metodo di apertura del file, il valore predefinito è "r", sola lettura

Risultato di ritorno:

I metodi supportati per i flag di parametro sono i seguenti:

  • 'r' è di sola lettura, verrà generato un errore se il file non esiste.
  • modalità di lettura e scrittura "r +", verrà generato un errore se il file non esiste.
  • "w" è solo scritto, il file verrà creato automaticamente se non esiste e verrà cancellato se esiste.
  • modalità di lettura e scrittura 'w +', il file viene creato automaticamente se non esiste.
  • 'a' solo metodo di aggiunta in scrittura, il file verrà creato automaticamente se non esiste.
  • metodo di aggiunta di lettura e scrittura 'a +', il file verrà creato automaticamente se non esiste.

open

Apri descrittore di file

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

Parametri di chiamata:

  • fname : String, specifica il nome del file
  • flags : String, specifica il metodo di apertura del file, il valore predefinito è "r", sola lettura
  • mode : numero intero, quando si crea un file, specificare la modalità del file, il valore predefinito è 0666

Risultato di ritorno:

  • Integer , restituisce il descrittore di file aperto

I metodi supportati per i flag di parametro sono i seguenti:

  • 'r' è di sola lettura, verrà generato un errore se il file non esiste.
  • modalità di lettura e scrittura "r +", verrà generato un errore se il file non esiste.
  • "w" è solo scritto, il file verrà creato automaticamente se non esiste e verrà cancellato se esiste.
  • modalità di lettura e scrittura 'w +', il file viene creato automaticamente se non esiste.
  • 'a' solo metodo di aggiunta in scrittura, il file verrà creato automaticamente se non esiste.
  • metodo di aggiunta di lettura e scrittura 'a +', il file verrà creato automaticamente se non esiste.

close

Chiudi descrittore di file

1
static fs.close(Integer fd) async;

Parametri di chiamata:

  • fd : intero, descrittore di file

openTextStream

Apri un file di testo per leggere, scrivere o leggere e scrivere simultaneamente

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

Parametri di chiamata:

  • fname : String, specifica il nome del file
  • flags : String, specifica il metodo di apertura del file, il valore predefinito è "r", sola lettura

Risultato di ritorno:

I metodi supportati per i flag di parametro sono i seguenti:

  • 'r' è di sola lettura, verrà generato un errore se il file non esiste.
  • modalità di lettura e scrittura "r +", verrà generato un errore se il file non esiste.
  • "w" è solo scritto, il file verrà creato automaticamente se non esiste e verrà cancellato se esiste.
  • modalità di lettura-scrittura 'w +', il file verrà creato automaticamente se non esiste.
  • 'a' solo metodo di aggiunta in scrittura, il file verrà creato automaticamente se non esiste.
  • metodo di aggiunta di lettura e scrittura 'a +', il file verrà creato automaticamente se non esiste.

readTextFile

Apri il file di testo e leggi il contenuto

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

Parametri di chiamata:

  • fname : String, specifica il nome del file

Risultato di ritorno:

  • String , restituisce il contenuto di testo del file

readFile

Apri il file binario e leggi il contenuto

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

Parametri di chiamata:

  • fname : String, specifica il nome del file
  • encoding : String, specifica il metodo di decodifica, l'impostazione predefinita non è decodificare

Risultato di ritorno:

  • Variant , restituisce il contenuto di testo del file

readLines

Apri il file e leggi un gruppo di righe di testo in un array. La fine della riga si basa sull'impostazione dell'attributo EOL. Per impostazione predefinita, posix: "\ n"; windows: "\ r \ n"

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

Parametri di chiamata:

  • fname : String, specifica il nome del file
  • maxlines : Integer, specifica il numero massimo di righe lette questa volta, leggi tutte le righe di testo per impostazione predefinita

Risultato di ritorno:

  • Array , restituisce l'array di righe di testo letto, se non ci sono dati da leggere o la connessione è interrotta, array vuoto

writeTextFile

Crea un file di testo e scrivi il contenuto

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

Parametri di chiamata:

  • fname : String, specifica il nome del file
  • txt : String, specifica la stringa da scrivere

writeFile

Crea un file binario e scrivi il contenuto

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

Parametri di chiamata:

  • fname : String, specifica il nome del file
  • data : Buffer , specifica i dati binari da scrivere

appendFile

Crea un file binario e scrivi il contenuto

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

Parametri di chiamata:

  • fname : String, specifica il nome del file
  • data : Buffer , specifica i dati binari da scrivere

setZipFS

Imposta la mappatura del file virtuale zip

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

Parametri di chiamata:

  • fname : String, specifica il percorso di mappatura
  • data : Buffer , specifica i dati del file zip mappato

clearZipFS

Cancella la mappatura del file virtuale zip

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

Parametri di chiamata:

  • fname : String, specifica il percorso di mappatura, cancella tutte le cache per impostazione predefinita

watch

Osserva un file e restituisci l'oggetto watcher corrispondente

1
static FSWatcher fs.watch(String fname);

Parametri di chiamata:

  • fname : String, specifica l'oggetto file da osservare

Risultato di ritorno:


Osserva un file e restituisci l'oggetto watcher corrispondente

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

Parametri di chiamata:

  • fname : String, specifica l'oggetto file da osservare
  • callback : Function, (evtType: 'change' | 'rename', filename: string) => any Processing callback quando l'oggetto file cambia

Risultato di ritorno:


Osserva un file e restituisci l'oggetto watcher corrispondente

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

Parametri di chiamata:

  • fname : String, specifica l'oggetto file da osservare
  • options : oggetto, opzioni di osservazione
  • options.persistent : {boolean} default: true se il processo non verrà chiuso fintanto che il file di destinazione è ancora in fase di osservazione
  • options.recursive : {boolean} predefinito: false Se fname è una cartella, se osservare tutte le sottodirectory in modo ricorsivo
  • options.encoding : {enum} default: 'utf8' specifica la codifica dei caratteri per analizzare l'fname in arrivo

Risultato di ritorno:


Osserva un file e restituisci l'oggetto watcher corrispondente

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

Parametri di chiamata:

  • fname : String, specifica l'oggetto file da osservare
  • options : oggetto, opzioni di osservazione
  • options.persistent : {boolean} default: true se il processo non verrà chiuso fintanto che il file di destinazione è ancora in fase di osservazione
  • options.recursive : {boolean} predefinito: false Se fname è una cartella, se osservare tutte le sottodirectory in modo ricorsivo
  • options.encoding : {enum} default: 'utf8' specifica la codifica dei caratteri per analizzare l'fname in arrivo
  • callback : (evtType: 'change' | 'rename', filename: string) => any Processing callback quando l'oggetto file cambia

Risultato di ritorno:


watchFile

Osserva un file e restituisci l'oggetto StatsWatcher corrispondente

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

Parametri di chiamata:

  • fname : String, specifica l'oggetto file da osservare
  • callback : Function, (curStats: Stats, prevStats: Stats) => any Processing callback quando cambiano le statistiche dell'oggetto file

Risultato di ritorno:


Osserva un file e restituisci l'oggetto StatsWatcher corrispondente

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

Parametri di chiamata:

  • fname : String, specifica l'oggetto file da osservare
  • options : oggetto, opzioni di osservazione
  • options.persistent : {boolean} default: true se il processo non terminerà fintanto che il file di destinazione viene ancora osservato
  • options.recursive : {boolean} predefinito: false Se fname è una cartella, se osservare tutte le sottodirectory in modo ricorsivo
  • options.encoding : {enum} default: 'utf8' specifica la codifica dei caratteri per analizzare l'fname in arrivo
  • callback : (curStats: Stats, prevStats: Stats) => any Processing callback quando cambiano le statistiche dell'oggetto file

Risultato di ritorno:


unwatchFile

Rimuovere i callback di tutti gli eventi di osservazione dallo StatsWatcher che osserva fname

1
static fs.unwatchFile(String fname);

Parametri di chiamata:

  • fname : String, specifica l'oggetto file da osservare

Risultato di ritorno:


Rimuovere il callback callback dal callback dell'evento di osservazione di StatsWatcher che osserva fname

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

Parametri di chiamata:

  • fname : String, specifica l'oggetto file da osservare
  • callback : funzione, callback da rimuovere

Risultato di ritorno:

Anche se il callback non è più nel callback dell'evento di osservazione StatsWatcher , non verrà segnalato alcun errore

Proprietà statiche

constants

Object, oggetto costante del modulo fs

1
static readonly Object fs.constants;

costante

SEEK_SET

modalità di ricerca costante, passare alla posizione assoluta

1
const fs.SEEK_SET = 0;

SEEK_CUR

La costante della modalità di ricerca, sposta alla posizione relativa della posizione corrente

1
const fs.SEEK_CUR = 1;

SEEK_END

modalità di ricerca costante, spostarsi nella posizione relativa della fine del file

1
const fs.SEEK_END = 2;