Module module de base

Module fs

Module de traitement du système de fichiers

Comment utiliser:

1
var fs = require('fs');

Fonction statique

exists

Demande 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écifie le chemin d'accès à la requête

Renvoie le résultat:

  • Boolean , retourne True si le fichier ou le répertoire existe

access

Interrogation des autorisations utilisateur sur un fichier spécifié

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

Paramètres d'appel:

  • path : String, spécifie le chemin d'accès à la requête
  • mode : entier, spécifiez l'autorisation de requête, la valeur par défaut est de savoir si le fichier existe

Créez des fichiers de lien dur, 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écifiant le chemin à supprimer

mkdir

Créer un répertoire

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

Paramètres d'appel:

  • path : String, spécifie 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écifie 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écifie le nouveau nom de fichier à modifier

copy

Copiez 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écifie le nouveau nom de fichier à modifier

chmod

Définit les autorisations d'accès pour le 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 : String, le fichier spécifié
  • mode : Entier, spécifiez les droits d'accès définis

lchmod

Définissez le droit d'accès du fichier spécifié. Si le fichier est un lien logiciel, l'autorisation sur le fichier n'est pas modifiée. Uniquement disponible sur les plates-formes macOS et BSD.

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

Paramètres d'appel:

  • path : String, le fichier spécifié
  • mode : Entier, spécifiez les droits d'accès définis

chown

Définit 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 : String, le fichier spécifié
  • uid : Entier, ID utilisateur du propriétaire du fichier
  • gid : entier, identifiant du groupe de propriétaires de fichiers

lchown

Définissez le propriétaire du fichier spécifié. Si le fichier spécifié est un lien logiciel, il ne changera pas le propriétaire du fichier. 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 : String, le fichier spécifié
  • uid : Entier, ID utilisateur du propriétaire du fichier
  • gid : entier, identifiant du groupe de propriétaires de fichiers

stat

Interroger les informations de base d'un fichier spécifié

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

Paramètres d'appel:

  • path : String, le fichier à interroger

Renvoie le résultat:

  • Stat , retourne les informations de base du fichier

lstat

Recherchez les informations de base du fichier spécifié. Contrairement à stat, lorsque path est un lien logiciel, les informations du lien logiciel seront renvoyées à la place des informations du fichier pointé.

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

Paramètres d'appel:

  • path : String, le fichier à interroger

Renvoie le résultat:

  • Stat , retourne les informations de base du fichier

Lire 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 : String, spécifie le fichier de lien logiciel à lire

Renvoie le résultat:

  • String , renvoie le nom de fichier indiqué par le lien logiciel

realpath

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

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

Paramètres d'appel:

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

Renvoie le résultat:

  • String , retourne le chemin absolu traité

Créer un fichier de lien logiciel

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 inexistant
  • linkpath : String, le fichier de lien linkpath à créer
  • type : String, type de connexion logicielle à créer. Les types facultatifs sont 'file', 'dir', 'junction', et la valeur par défaut est 'file'. Ce paramètre n'est valide que sur Windows. Lorsqu'il s'agit de 'junction' Le chemin de liaison du chemin cible doit être un chemin absolu et la cible est 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, elle sera complétée par «\ 0», sinon plus que le contenu du fichier sera perdu.

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

Paramètres d'appel:

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

read

Lire le contenu du fichier en fonction du descripteur de 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 lecture est écrit
  • offset : Integer, Buffer write offset, default is 0
  • length : entier, le nombre d'octets lus par 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

Renvoie le résultat:

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

fchmod

Modifiez le mode de fichier en fonction du descripteur de fichier. Valable uniquement sur les systèmes 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

Modifiez le propriétaire en fonction du descripteur de fichier. Valable uniquement sur les systèmes 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

Synchroniser les données sur le disque en fonction des descripteurs de fichiers

1
static fs.fdatasync(Integer fd) async;

Paramètres d'appel:

  • fd : Entier, descripteur de fichier

fsync

Synchroniser les données sur le disque en fonction des descripteurs de fichiers

1
static fs.fsync(Integer fd) async;

Paramètres d'appel:

  • fd : Entier, descripteur de fichier

readdir

Lire les informations de fichier du répertoire spécifié

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

Paramètres d'appel:

  • path : String, spécifiez le répertoire de la requête

Renvoie le résultat:

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

openFile

Ouvrir le fichier pour la lecture, l'écriture ou la lecture et l'écriture

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écifie la méthode d'ouverture de fichier, la valeur par défaut est "r", mode lecture seule

Renvoie le résultat:

Les indicateurs sont pris en charge des manières suivantes:

  • 'r' Mode lecture seule. Génère une erreur si le fichier n'existe pas.
  • 'r +' Mode lecture et écriture. Si le fichier n'existe pas, une erreur est générée.
  • 'w' Mode écriture seule. Le fichier sera créé automatiquement s'il n'existe pas et il sera vidé s'il existe.
  • 'w +' Mode lecture et écriture, le fichier sera créé automatiquement s'il n'existe pas.
  • 'a' n'écrit que la méthode add, le fichier est créé automatiquement s'il n'existe pas.
  • 'a +' En mode lecture et écriture, le fichier est créé automatiquement s'il n'existe pas.

open

Description du fichier ouvert

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écifie la méthode d'ouverture de fichier, la valeur par défaut est "r", mode lecture seule
  • mode : Entier, spécifiez le mode du fichier lors de la création du fichier, par défaut 0666

Renvoie le résultat:

  • Integer , retourne le descripteur de fichier ouvert

Les indicateurs sont pris en charge des manières suivantes:

  • 'r' Mode lecture seule. Génère une erreur si le fichier n'existe pas.
  • 'r +' Mode lecture et écriture. Si le fichier n'existe pas, une erreur est générée.
  • 'w' Mode écriture seule. Le fichier sera créé automatiquement s'il n'existe pas et il sera vidé s'il existe.
  • 'w +' Mode lecture et écriture, le fichier sera créé automatiquement s'il n'existe pas.
  • 'a' n'écrit que la méthode add, le fichier est créé automatiquement s'il n'existe pas.
  • 'a +' Mode d'ajout en lecture et en écriture, le fichier est créé automatiquement 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 la lecture, l'écriture ou les deux

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écifie la méthode d'ouverture de fichier, la valeur par défaut est "r", mode lecture seule

Renvoie le résultat:

Les indicateurs sont pris en charge des manières suivantes:

  • 'r' Mode lecture seule. Génère une erreur si le fichier n'existe pas.
  • 'r +' Mode lecture et écriture. Si le fichier n'existe pas, une erreur est générée.
  • 'w' Mode écriture seule. Le fichier sera créé automatiquement s'il n'existe pas et il sera vidé s'il existe.
  • 'w +' Mode lecture et écriture, le fichier sera créé automatiquement s'il n'existe pas.
  • 'a' n'écrit que la méthode add, le fichier est créé automatiquement s'il n'existe pas.
  • 'a +' Mode d'ajout en lecture et en écriture, le fichier est créé automatiquement 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

Renvoie le résultat:

  • String , retourne le contenu texte 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écifie la méthode de décodage et ne décode pas par défaut

Renvoie le résultat:

  • Variant , retourne le contenu texte du fichier

readLines

Ouvrez le fichier et lisez un ensemble de lignes de texte dans un tableau. L'identification de fin de ligne est basée sur le paramètre de la propriété EOL.

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 à lire cette fois, par défaut pour lire toutes les lignes de texte

Renvoie le résultat:

  • Array , renvoie un tableau de lignes de texte lues, si aucune donnée n'est disponible ou si la connexion est interrompue, un tableau vide

writeTextFile

Créer un fichier texte et écrire 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éez un fichier binaire et écrivez le 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écifie les données binaires à écrire

appendFile

Créez un fichier binaire et écrivez le 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écifie les données binaires à écrire

setZipFS

Configurer le mappage de fichier virtuel zip

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

Paramètres d'appel:

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

clearZipFS

Effacer le mappage des fichiers virtuels zip

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

Paramètres d'appel:

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

Propriété statique

constants

Objet, objet constant du module fs

1
static readonly Object fs.constants;

Constante

SEEK_SET

rechercher le mode constant, passer en position absolue

1
const fs.SEEK_SET = 0;

SEEK_CUR

rechercher le mode constant, passer à la position relative de la position actuelle

1
const fs.SEEK_CUR = 1;

SEEK_END

rechercher le mode constant, passer à la position relative à la fin du fichier

1
const fs.SEEK_END = 2;