Modulo Modulo base

Modulo fs

Modulo di elaborazione del file system

Istruzioni:

1
var fs = require('fs');

Funzione statica

exists

Controlla se esiste il file o la directory specificati

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

Parametri di chiamata:

  • path : stringa, specificare il percorso da interrogare

Risultato di ritorno:

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

access

Interroga le autorizzazioni dell'utente sul file specificato

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

Parametri di chiamata:

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

Crea un file di collegamento reale, 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, specificare 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, specifica autorizzazioni 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, specifica il nuovo nome del 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, specifica il nuovo nome del file da modificare

chmod

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

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

Parametri di chiamata:

  • path : String, il file dell'operazione specificato
  • mode : numero intero, specificare i diritti di accesso impostati

lchmod

Impostare le autorizzazioni di accesso al file specificato Se il file è un collegamento software, l'autorizzazione a puntare al file non viene modificata, ma è disponibile solo sulle piattaforme serie macOS e BSD.

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

Parametri di chiamata:

  • path : String, il file dell'operazione specificato
  • mode : numero intero, specificare i diritti di accesso impostati

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, specificare il file di impostazione
  • uid : intero, ID utente del proprietario del file
  • gid : intero, ID gruppo proprietario file

lchown

Impostare il proprietario del file specificato, se il file specificato è un collegamento software, non cambierà il proprietario del file indicato, Windows non supporta questo metodo

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

Parametri di chiamata:

  • path : stringa, specificare il file di impostazione
  • uid : intero, ID utente del proprietario del file
  • gid : intero, ID gruppo proprietario file

stat

Interroga le informazioni di base del file specificato

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

Parametri di chiamata:

  • path : String, il file di query specificato

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 path è un collegamento software, le informazioni restituite saranno il collegamento software anziché il file indicato.

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

Parametri di chiamata:

  • path : String, il file di query specificato

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 : String, specifica il file di collegamento soft 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 anche il percorso specificato contiene un percorso relativo verrà espanso

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

Parametri di chiamata:

  • path : String, specifica il percorso da leggere

Risultato di ritorno:

  • String , restituisce il percorso assoluto dopo l'elaborazione

Creare un file di collegamento software

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

Parametri di chiamata:

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

truncate

Modifica la dimensione del file, se la lunghezza specificata è maggiore della dimensione del file di origine, quindi usa "\ 0" per riempire, altrimenti il ​​contenuto del file andrà perso

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

Parametri di chiamata:

  • path : stringa, specificare 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 di lettura
  • offset : intero, offset scrittura Buffer , il valore predefinito è 0
  • length : numero intero, il numero di byte letti dal file, il valore predefinito è 0
  • position : numero intero, la posizione di lettura del file, il valore predefinito è la posizione corrente del file

Risultato di ritorno:

  • Numero Integer , il numero effettivo di byte letti

fchmod

In base al descrittore di file, modificare la modalità file. Valido solo su sistemi POSIX.

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

Parametri di chiamata:

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

fchown

In base al descrittore di file, modificare il proprietario. Valido solo su sistemi POSIX.

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

Parametri di chiamata:

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

fdatasync

Sincronizza i dati su disco in base al descrittore di file

1
static fs.fdatasync(Integer fd) async;

Parametri di chiamata:

  • fd : intero, descrittore di file

fsync

Sincronizza i dati su disco in base al descrittore di file

1
static fs.fsync(Integer fd) async;

Parametri di chiamata:

  • fd : intero, descrittore di file

readdir

Leggi le informazioni sul file della directory specificata

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

Parametri di chiamata:

  • path : stringa, specificare la directory della query

Risultato di ritorno:

  • NArray , restituisce l'array di informazioni sul file della directory

openFile

Apri il file per leggere, scrivere o leggere e scrivere contemporaneamente

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 la modalità di apertura del file, il valore predefinito è "r", modalità di sola lettura

Risultato di ritorno:

I flag dei parametri sono supportati come segue:

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

open

Apri il 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 la modalità di apertura del file, il valore predefinito è "r", modalità di sola lettura
  • mode : Integer, durante la creazione di un file, specifica la modalità file, impostazione predefinita 0666

Risultato di ritorno:

  • Integer , restituisce il descrittore di file aperto

I flag dei parametri sono supportati come segue:

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

close

Chiudi il 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 entrambi

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 la modalità di apertura del file, il valore predefinito è "r", modalità di sola lettura

Risultato di ritorno:

I flag dei parametri sono supportati come segue:

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

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 del 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 : stringa, specifica il metodo di decodifica, nessuna decodifica per impostazione predefinita

Risultato di ritorno:

  • Variant , restituisce il contenuto testuale del file

readLines

Apri il file e leggi un set di righe di testo in un array. La fine della riga identifica l'impostazione in base all'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 : numero intero, specificare il numero massimo di righe lette questa volta, leggere 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 file di testo e scrivi contenuti

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 , specificare 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 , specificare i dati binari da scrivere

setZipFS

Imposta il mapping dei file virtuali 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 mappatura file virtuale zip

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

Parametri di chiamata:

  • fname : String, specifica il percorso di mappatura, cancella tutta la cache per impostazione predefinita

Proprietà statica

constants

Oggetto, oggetto costante del modulo fs

1
static readonly Object fs.constants;

costante

SEEK_SET

modalità di ricerca costante, spostamento in posizione assoluta

1
const fs.SEEK_SET = 0;

SEEK_CUR

costante della modalità di ricerca, passare alla posizione relativa della posizione corrente

1
const fs.SEEK_CUR = 1;

SEEK_END

costante della modalità di ricerca, passa alla posizione relativa della fine del file

1
const fs.SEEK_END = 2;