Module module de base

Module fs

Module de traitement du système de fichiers

Instructions:

1
var fs = require('fs');

Quelques notes:

  • L'exécution de fs.watch(filename) renverra un observateur hérité d' EventEmitter , qui prend en charge trois événements de «change», «changeonly» et «renameonly »
  • fs.watchFile(target) et fs.unwatchFile(target) peuvent toujours être utilisés par paires
  • fs.watchFile(target) renverra un objet StatsWatcher hérité d' EventEmitter , appeler fs.unwatchFile(target) équivaut à appeler StatsWatcher.close() .

Fonction statique

exists

Demander si le fichier ou le répertoire spécifié existe

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

Paramètres d'appel:

  • path : String, spécifiez le chemin à interroger

Résultat de retour:

  • Boolean , renvoie True pour indiquer que le fichier ou le répertoire existe

access

Interroger les droits de l'utilisateur sur le fichier spécifié

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

Paramètres d'appel:

  • path : String, spécifiez le chemin à interroger
  • mode : Entier, spécifiez les autorisations de requête, la valeur par défaut est si le fichier existe

Créer un fichier de lien physique, cette méthode n'est pas prise en charge sous Windows

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

Paramètres d'appel:

  • oldPath : String, fichier source
  • newPath : String, le fichier à créer

Supprimer le fichier spécifié

1
static fs.unlink(String path) async;

Paramètres d'appel:

  • path : String, spécifiez le chemin à supprimer

mkdir

Créer un annuaire

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

Paramètres d'appel:

  • path : String, spécifiez le nom du répertoire à créer
  • mode : Entier, spécifiez les autorisations de fichier, Windows ignore ce paramètre

rmdir

Supprimer un répertoire

1
static fs.rmdir(String path) async;

Paramètres d'appel:

  • path : String, spécifiez le nom du répertoire à supprimer

rename

Renommer un fichier

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

Paramètres d'appel:

  • from : String, spécifiez le fichier renommé
  • to : String, spécifiez le nouveau nom de fichier à modifier

copy

Copier un fichier

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

Paramètres d'appel:

  • from : String, spécifiez le fichier renommé
  • to : String, spécifiez le nouveau nom de fichier à modifier

chmod

Définissez l'autorisation d'accès du fichier spécifié, Windows ne prend pas en charge cette méthode

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

Paramètres d'appel:

  • path : chaîne, spécifiez le fichier d'opération
  • mode : entier, spécifiez l'autorité d'accès définie

lchmod

Définissez l'autorisation d'accès du fichier spécifié. Si le fichier est un lien logiciel, l'autorisation d'accès au fichier ne sera pas modifiée. Elle n'est disponible que sur les plates-formes des séries macOS et BSD

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

Paramètres d'appel:

  • path : chaîne, spécifiez le fichier d'opération
  • mode : entier, spécifiez l'autorité d'accès définie

chown

Définissez le propriétaire du fichier spécifié, Windows ne prend pas en charge cette méthode

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

Paramètres d'appel:

  • path : chaîne, spécifiez le fichier défini
  • uid : Integer, ID utilisateur du propriétaire du fichier
  • gid : Integer, identifiant du groupe du propriétaire du fichier

lchown

Définit le propriétaire du fichier spécifié. Si le fichier spécifié est un lien logiciel, le propriétaire du fichier pointé ne sera pas modifié. Windows ne prend pas en charge cette méthode

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

Paramètres d'appel:

  • path : chaîne, spécifiez le fichier défini
  • uid : Integer, ID utilisateur du propriétaire du fichier
  • gid : Integer, identifiant du groupe du propriétaire du fichier

stat

Interroger les informations de base du fichier spécifié

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

Paramètres d'appel:

  • path : String, spécifiez le fichier à interroger

Résultat de retour:

  • Stat , renvoie les informations de base du fichier

lstat

Interroge les informations de base du fichier spécifié. Contrairement à stat, lorsque le path est une connexion logicielle, les informations renvoyées seront les informations de la connexion logicielle au lieu des informations du fichier pointé

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

Paramètres d'appel:

  • path : String, spécifiez le fichier à interroger

Résultat de retour:

  • Stat , renvoie les informations de base du fichier

Lisez le fichier de connexion logicielle spécifié, cette méthode n'est pas prise en charge sous Windows

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

Paramètres d'appel:

  • path : chaîne, spécifiez le fichier de connexion logicielle à lire

Résultat de retour:

  • String , renvoie le nom du fichier pointé par le lien logiciel

realpath

Renvoie le chemin absolu du chemin spécifié, si le chemin spécifié contient un chemin relatif, il sera également développé

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

Paramètres d'appel:

  • path : String, spécifiez le chemin à lire

Résultat de retour:

  • String , renvoie le chemin absolu traité

Créer un fichier de connexion logicielle

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

Paramètres d'appel:

  • target : String, le fichier cible, qui peut être un fichier, un répertoire ou un chemin qui n'existe pas
  • linkpath : String, le fichier de lien linkpath à créer
  • type : String, le type de connexion logicielle créée, les types optionnels sont'file ',' dir ',' junction ', la valeur par défaut est'file', ce paramètre n'est valide que sur windows, il sera créé quand il s'agit de'jonction ' Le chemin de la cible linkpath doit être un chemin absolu et la cible sera automatiquement convertie en chemin absolu.

truncate

Modifiez la taille du fichier, si la longueur spécifiée est supérieure à la taille du fichier source, remplissez-la avec '\ 0', sinon le contenu du fichier sera perdu

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

Paramètres d'appel:

  • path : String, spécifiez le chemin du fichier modifié
  • len : Integer, spécifiez la taille du fichier modifié

read

Selon le descripteur de fichier, lisez le contenu du fichier

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

Paramètres d'appel:

  • fd : entier, descripteur de fichier
  • buffer : Buffer , l'objet Buffer dans lequel le résultat de la lecture est écrit
  • offset : entier, offset d'écriture du Buffer , la valeur par défaut est 0
  • length : Integer, le nombre d'octets lus dans le fichier, la valeur par défaut est 0
  • position : Entier, la position de lecture du fichier, la valeur par défaut est la position actuelle du fichier

Résultat de retour:

  • Integer , le nombre d'octets réellement lus

fchmod

Selon le descripteur de fichier, changez le mode de fichier. Uniquement valable dans le système POSIX.

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

Paramètres d'appel:

  • fd : entier, descripteur de fichier
  • mode : Integer, le mode du fichier

fchown

Selon le descripteur de fichier, changez le propriétaire. Uniquement valable dans le système POSIX.

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

Paramètres d'appel:

  • fd : entier, descripteur de fichier
  • uid : Entier, ID utilisateur
  • gid : Entier, identifiant de groupe

fdatasync

Selon le descripteur de fichier, synchroniser les données sur le disque

1
static fs.fdatasync(Integer fd) async;

Paramètres d'appel:

  • fd : entier, descripteur de fichier

fsync

Selon le descripteur de fichier, synchroniser les données sur le disque

1
static fs.fsync(Integer fd) async;

Paramètres d'appel:

  • fd : entier, descripteur de fichier

readdir

Lire les informations de fichier dans le répertoire spécifié

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

Paramètres d'appel:

  • path : String, spécifiez le répertoire à interroger

Résultat de retour:

  • NArray , retourne le tableau d'informations sur les fichiers du répertoire

openFile

Ouvrez le fichier pour lecture, écriture ou lecture et écriture simultanées

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

Paramètres d'appel:

  • fname : String, spécifiez le nom du fichier
  • flags : String, spécifiez la méthode d'ouverture du fichier, la valeur par défaut est "r", lecture seule

Résultat de retour:

Les méthodes prises en charge des indicateurs de paramètre sont les suivantes:

  • 'r' est en lecture seule, une erreur est générée si le fichier n'existe pas.
  • En mode lecture et écriture 'r +', une erreur sera générée si le fichier n'existe pas.
  • 'w' est écrit uniquement, le fichier sera créé automatiquement s'il n'existe pas, et sera effacé s'il existe.
  • En mode lecture et écriture 'w +', le fichier sera créé automatiquement s'il n'existe pas.
  • 'une' méthode d'ajout d'écriture seulement, le fichier sera créé automatiquement s'il n'existe pas.
  • 'a +' méthode d'ajout en lecture-écriture, le fichier est automatiquement créé s'il n'existe pas.

open

Ouvrir le descripteur de fichier

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

Paramètres d'appel:

  • fname : String, spécifiez le nom du fichier
  • flags : String, spécifiez la méthode d'ouverture du fichier, la valeur par défaut est "r", lecture seule
  • mode : Entier, lors de la création d'un fichier, spécifiez le mode du fichier, la valeur par défaut est 0666

Résultat de retour:

  • Integer , renvoie le descripteur de fichier ouvert

Les méthodes prises en charge des indicateurs de paramètre sont les suivantes:

  • «r» est en lecture seule, une erreur sera générée si le fichier n'existe pas.
  • En mode lecture et écriture 'r +', une erreur sera générée si le fichier n'existe pas.
  • 'w' est écrit uniquement, le fichier sera créé automatiquement s'il n'existe pas, et sera effacé s'il existe.
  • En mode lecture et écriture 'w +', le fichier sera créé automatiquement s'il n'existe pas.
  • 'une' méthode d'ajout d'écriture seulement, le fichier sera créé automatiquement s'il n'existe pas.
  • 'a +' méthode d'ajout en lecture-écriture, le fichier est automatiquement créé s'il n'existe pas.

close

Fermer le descripteur de fichier

1
static fs.close(Integer fd) async;

Paramètres d'appel:

  • fd : entier, descripteur de fichier

openTextStream

Ouvrez un fichier texte pour lire, écrire ou lire et écrire simultanément

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

Paramètres d'appel:

  • fname : String, spécifiez le nom du fichier
  • flags : String, spécifiez la méthode d'ouverture du fichier, la valeur par défaut est "r", lecture seule

Résultat de retour:

Les méthodes prises en charge des indicateurs de paramètre sont les suivantes:

  • «r» est en lecture seule, une erreur sera générée si le fichier n'existe pas.
  • En mode lecture et écriture 'r +', une erreur sera générée si le fichier n'existe pas.
  • 'w' est écrit uniquement, le fichier sera créé automatiquement s'il n'existe pas, et sera effacé s'il existe.
  • En mode lecture et écriture 'w +', le fichier sera créé automatiquement s'il n'existe pas.
  • 'une' méthode d'ajout d'écriture seulement, le fichier sera créé automatiquement s'il n'existe pas.
  • 'a +' méthode d'ajout en lecture-écriture, le fichier est automatiquement créé s'il n'existe pas.

readTextFile

Ouvrez le fichier texte et lisez le contenu

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

Paramètres d'appel:

  • fname : String, spécifiez le nom du fichier

Résultat de retour:

  • String , renvoie le contenu textuel du fichier

readFile

Ouvrez le fichier binaire et lisez le contenu

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

Paramètres d'appel:

  • fname : String, spécifiez le nom du fichier
  • encoding : String, spécifiez la méthode de décodage, la valeur par défaut n'est pas de décoder

Résultat de retour:

  • Variant , renvoie le contenu textuel du fichier

readLines

Ouvrez le fichier et lisez un groupe de lignes de texte dans un tableau. La fin de la ligne est basée sur le paramètre de l'attribut EOL. Par défaut, posix: "\ n"; windows: "\ r \ n"

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

Paramètres d'appel:

  • fname : String, spécifiez le nom du fichier
  • maxlines : Entier, spécifiez le nombre maximum de lignes lues cette fois, lisez toutes les lignes de texte par défaut

Résultat de retour:

  • Array , renvoie le tableau de lignes de texte lu, s'il n'y a pas de données à lire ou si la connexion est interrompue, tableau vide

writeTextFile

Créer un fichier texte et rédiger du contenu

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

Paramètres d'appel:

  • fname : String, spécifiez le nom du fichier
  • txt : String, spécifiez la chaîne à écrire

writeFile

Créer un fichier binaire et écrire du contenu

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

Paramètres d'appel:

  • fname : String, spécifiez le nom du fichier
  • data : Buffer , spécifiez les données binaires à écrire

appendFile

Créer un fichier binaire et écrire du contenu

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

Paramètres d'appel:

  • fname : String, spécifiez le nom du fichier
  • data : Buffer , spécifiez les données binaires à écrire

setZipFS

Définir le mappage de fichiers virtuels zip

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

Paramètres d'appel:

  • fname : String, spécifiez le chemin du mappage
  • data : Buffer , spécifiez les données du fichier zip mappé

clearZipFS

Effacer le mappage de fichiers virtuels zip

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

Paramètres d'appel:

  • fname : String, spécifiez le chemin de mappage, effacez tous les caches par défaut

watch

Observer un fichier et renvoyer l'objet watcher correspondant

1
static FSWatcher fs.watch(String fname);

Paramètres d'appel:

  • fname : String, spécifiez l'objet fichier à observer

Résultat de retour:


Observer un fichier et renvoyer l'objet watcher correspondant

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

Paramètres d'appel:

  • fname : String, spécifiez l'objet fichier à observer
  • callback : Function, (evtType: 'change' | 'rename', filename: string) => any Traitement de rappel lorsque l'objet fichier change

Résultat de retour:


Observer un fichier et renvoyer l'objet watcher correspondant

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

Paramètres d'appel:

  • fname : String, spécifiez l'objet fichier à observer
  • options : objet, options d'observation
  • options.persistent : {boolean} default: true si le processus ne se terminera pas tant que le fichier cible est toujours observé
  • options.recursive : {boolean} default: false Dans le cas où fname est un dossier, s'il faut observer tous les sous-répertoires sous celui-ci de manière récursive
  • options.encoding : {enum} default: 'utf8' spécifie l'encodage des caractères pour l'analyse du fname entrant

Résultat de retour:


Observer un fichier et renvoyer l'objet watcher correspondant

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

Paramètres d'appel:

  • fname : String, spécifiez l'objet fichier à observer
  • options : objet, options d'observation
  • options.persistent : {boolean} default: true si le processus ne se terminera pas tant que le fichier cible est toujours observé
  • options.recursive : {boolean} default: false Dans le cas où fname est un dossier, s'il faut observer tous les sous-répertoires sous celui-ci de manière récursive
  • options.encoding : {enum} default: 'utf8' spécifie l'encodage des caractères pour l'analyse du fname entrant
  • callback : (evtType: 'change' | 'rename', filename: string) => any Traitement de rappel lorsque l'objet fichier change

Résultat de retour:


watchFile

Observez un fichier et renvoyez l'objet StatsWatcher correspondant

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

Paramètres d'appel:

  • fname : String, spécifiez l'objet fichier à observer
  • callback : Function, (curStats: Stats, prevStats: Stats) => any Traitement de rappel lorsque les statistiques de l'objet fichier changent

Résultat de retour:


Observez un fichier et renvoyez l'objet StatsWatcher correspondant

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

Paramètres d'appel:

  • fname : String, spécifiez l'objet fichier à observer
  • options : objet, options d'observation
  • options.persistent : {boolean} default: true si le processus ne se terminera pas tant que le fichier cible est toujours observé
  • options.recursive : {boolean} default: false Dans le cas où fname est un dossier, s'il faut observer tous les sous-répertoires sous celui-ci de manière récursive
  • options.encoding : {enum} default: 'utf8' spécifie l'encodage des caractères pour l'analyse du fname entrant
  • callback : (curStats: Stats, prevStats: Stats) => any Processing callback lorsque les stats de l'objet fichier changent

Résultat de retour:


unwatchFile

Supprimez les rappels de tous les événements d'observation de StatsWatcher qui observe fname

1
static fs.unwatchFile(String fname);

Paramètres d'appel:

  • fname : String, spécifiez l'objet fichier à observer

Résultat de retour:


Supprimez le callback rappel du rappel d'événement d'observation de StatsWatcher qui observe fname

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

Paramètres d'appel:

  • fname : String, spécifiez l'objet fichier à observer
  • callback : Fonction, callback à supprimer

Résultat de retour:

Même si le rappel n'est plus dans le rappel d'événement d'observation StatsWatcher , aucune erreur ne sera signalée

Propriétés statiques

constants

Objet, objet constant du module fs

1
static readonly Object fs.constants;

constant

SEEK_SET

mode de recherche constant, passer en position absolue

1
const fs.SEEK_SET = 0;

SEEK_CUR

La constante du mode de recherche, se déplace vers la position relative de la position actuelle

1
const fs.SEEK_CUR = 1;

SEEK_END

constante de mode de recherche, se déplace vers la position relative de la fin du fichier

1
const fs.SEEK_END = 2;