Модуль Базовый модуль

Модуль ФС

Модуль обработки файловой системы

Как использовать:

1
var fs = require('fs');

Статическая функция

exists

Запрос, существует ли указанный файл или каталог

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

Параметры звонка:

  • path : строка, укажите путь к запросу

Вернуть результат:

  • Boolean , возвращает True, чтобы указать, что файл или каталог существует

access

Запросить права пользователя на указанный файл

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

Параметры звонка:

  • path : строка, укажите путь к запросу
  • mode : Integer, укажите разрешение запроса, по умолчанию используется файл

Создать файл жесткой ссылки, этот метод не поддерживается в Windows

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

Параметры звонка:

  • oldPath : String, исходный файл
  • newPath : String, файл, который будет создан

Удалить указанный файл

1
static fs.unlink(String path) async;

Параметры звонка:

  • path : строка, укажите путь для удаления

mkdir

Создать каталог

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

Параметры звонка:

  • path : строка, укажите имя каталога, который будет создан
  • mode : Integer, укажите права доступа к файлу, Windows игнорирует этот параметр

rmdir

Удалить каталог

1
static fs.rmdir(String path) async;

Параметры звонка:

  • path : строка, укажите имя каталога для удаления

rename

Переименовать файл

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

Параметры звонка:

  • from : String, укажите переименованный файл
  • to : String, указать новое имя файла для изменения

copy

Скопируйте файл

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

Параметры звонка:

  • from : String, укажите переименованный файл
  • to : String, указать новое имя файла для изменения

chmod

Установите права доступа для указанного файла, Windows не поддерживает этот метод

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

Параметры звонка:

  • path : строка, указанный файл
  • mode : целочисленный, укажите установленные права доступа

lchmod

Установите права доступа к указанному файлу. Если файл является мягкой ссылкой, разрешение на указание на файл не изменяется. Оно доступно только на платформах MacOS и BSD.

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

Параметры звонка:

  • path : строка, указанный файл
  • mode : целочисленный, укажите установленные права доступа

chown

Установить владельца указанного файла, Windows не поддерживает этот метод

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

Параметры звонка:

  • path : строка, укажите файл настроек
  • uid : Integer, идентификатор пользователя владельца файла
  • gid : Integer, идентификатор группы владельцев файлов

lchown

Установите владельца указанного файла. Если указанный файл является программной ссылкой, владелец файла не будет изменен. Windows не поддерживает этот метод.

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

Параметры звонка:

  • path : строка, укажите файл настроек
  • uid : Integer, идентификатор пользователя владельца файла
  • gid : Integer, идентификатор группы владельцев файлов

stat

Запрос основной информации указанного файла

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

Параметры звонка:

  • path : строка, указанный файл запроса

Вернуть результат:

  • Stat , вернуть основную информацию о файле

lstat

Запросите базовую информацию для указанного файла. В отличие от stat, когда path является мягкой ссылкой, возвращаемая информация будет мягкой ссылкой, а не указанным файлом.

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

Параметры звонка:

  • path : строка, указанный файл запроса

Вернуть результат:

  • Stat , вернуть основную информацию о файле

Прочитайте указанный файл софт-соединения, этот метод не поддерживается в Windows

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

Параметры звонка:

  • path : строка, укажите файл мягкой ссылки для чтения

Вернуть результат:

  • String , возвращает имя файла, на которое указывает программная ссылка

realpath

Возвращает абсолютный путь указанного пути, если указанный путь содержит относительный путь, также будет расширен

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

Параметры звонка:

  • path : String, укажите путь для чтения

Вернуть результат:

  • String , возвращает абсолютный путь после обработки

Создать файл софт-ссылки

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

Параметры звонка:

  • target : String, целевой файл, который может быть файлом, каталогом или несуществующим путем
  • linkpath : String, файл мягкой ссылки, который будет создан
  • type : String, type созданного программного соединения, необязательные типы: «file», «dir», «junction», по умолчанию «file», этот параметр действителен только в Windows, он будет создан, когда он «junction» Целевой путь пути должен быть абсолютным путем, и цель будет автоматически преобразована в абсолютный путь.

truncate

Измените размер файла, если указанная длина больше размера исходного файла, затем заполните его '\ 0', в противном случае содержимое файла будет потеряно

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

Параметры звонка:

  • path : String, укажите путь к измененному файлу
  • len : Integer, укажите размер измененного файла

read

В соответствии с дескриптором файла, прочитайте содержимое файла

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

Параметры звонка:

  • fd : целое число, дескриптор файла
  • buffer : Buffer , объект Buffer в который записывается результат чтения
  • offset : целое число, смещение записи Buffer , по умолчанию 0
  • length : целое число, число байтов, прочитанных из файла, по умолчанию 0
  • position : Integer, позиция чтения файла, по умолчанию текущая позиция файла

Вернуть результат:

  • Integer , фактическое число прочитанных байтов

fchmod

В соответствии с дескриптором файла, измените режим файла. Действует только в системах POSIX.

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

Параметры звонка:

  • fd : целое число, дескриптор файла
  • mode : целое, режим файла

fchown

Согласно дескриптору файла, смените владельца. Действует только в системах POSIX.

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

Параметры звонка:

  • fd : целое число, дескриптор файла
  • uid : целое число, идентификатор пользователя
  • gid : Integer, идентификатор группы

fdatasync

Синхронизировать данные на диск согласно дескриптору файла

1
static fs.fdatasync(Integer fd) async;

Параметры звонка:

  • fd : целое число, дескриптор файла

fsync

Синхронизировать данные на диск согласно дескриптору файла

1
static fs.fsync(Integer fd) async;

Параметры звонка:

  • fd : целое число, дескриптор файла

readdir

Прочитать информацию о файле указанного каталога

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

Параметры звонка:

  • path : строка, укажите каталог запроса

Вернуть результат:

  • NArray , возвращает массив информации о файле каталога

openFile

Открыть файл для чтения, записи или чтения и записи одновременно

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

Параметры звонка:

  • fname : String, укажите имя файла
  • flags : String, указать режим открытия файла, по умолчанию «r», режим только для чтения

Вернуть результат:

  • SeekableStream , возвращает открытый объект файла

Флаги параметров поддерживаются следующим образом:

  • 'r' только для чтения, выдается ошибка, если файл не существует.
  • Режим чтения и записи 'r +', выдает ошибку, если файл не существует.
  • Режим «w» только для записи, файл будет создан автоматически, если он не существует, и будет очищен, если он существует.
  • 'w +' метод чтения и записи, файл создается автоматически, если он не существует.
  • «a» записывает только метод добавления, он будет создан автоматически, если файл не существует.
  • a + метод чтения и записи, если файл не существует, он будет создан автоматически.

open

Открыть дескриптор файла

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

Параметры звонка:

  • fname : String, укажите имя файла
  • flags : String, указать режим открытия файла, по умолчанию «r», режим только для чтения
  • mode : Integer, при создании файла укажите режим файла, по умолчанию 0666

Вернуть результат:

  • Integer , возвращает дескриптор открытого файла

Флаги параметров поддерживаются следующим образом:

  • 'r' только для чтения, выдается ошибка, если файл не существует.
  • Режим чтения и записи 'r +', выдает ошибку, если файл не существует.
  • Режим «w» только для записи, файл будет создан автоматически, если он не существует, и будет очищен, если он существует.
  • 'w +' метод чтения и записи, файл создается автоматически, если он не существует.
  • «a» записывает только метод добавления, он будет создан автоматически, если файл не существует.
  • a + метод чтения и записи, если файл не существует, он будет создан автоматически.

close

Закрыть дескриптор файла

1
static fs.close(Integer fd) async;

Параметры звонка:

  • fd : целое число, дескриптор файла

openTextStream

Откройте текстовый файл для чтения, записи или обоих

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

Параметры звонка:

  • fname : String, укажите имя файла
  • flags : String, указать режим открытия файла, по умолчанию «r», режим только для чтения

Вернуть результат:

  • BufferedStream , возвращает открытый объект файла

Флаги параметров поддерживаются следующим образом:

  • 'r' только для чтения, выдается ошибка, если файл не существует.
  • Режим чтения и записи 'r +', выдает ошибку, если файл не существует.
  • Режим «w» только для записи, файл будет создан автоматически, если он не существует, и будет очищен, если он существует.
  • 'w +' метод чтения и записи, файл создается автоматически, если он не существует.
  • «a» записывает только метод добавления, он будет создан автоматически, если файл не существует.
  • a + метод чтения и записи, если файл не существует, он будет создан автоматически.

readTextFile

Откройте текстовый файл и прочитайте содержание

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

Параметры звонка:

  • fname : String, укажите имя файла

Вернуть результат:

  • String , возвращает текстовое содержимое файла

readFile

Откройте бинарный файл и прочитайте содержимое

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

Параметры звонка:

  • fname : String, укажите имя файла
  • encoding : String, укажите метод декодирования, по умолчанию декодирование отсутствует.

Вернуть результат:

  • Variant , возвращает текстовое содержимое файла

readLines

Откройте файл и прочитайте набор текстовых строк в массиве. Конец строки определяет настройку на основе атрибута EOL. По умолчанию posix: "\ n"; windows: "\ r \ n"

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

Параметры звонка:

  • fname : String, укажите имя файла
  • maxlines : целое число, укажите максимальное количество строк, читаемых на этот раз, по умолчанию читать все строки

Вернуть результат:

  • Array , возвращает массив строк текста для чтения, если нет данных для чтения или разорвано соединение, пустой массив

writeTextFile

Создать текстовый файл и написать контент

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

Параметры звонка:

  • fname : String, укажите имя файла
  • txt : String, укажите строку для записи

writeFile

Создайте двоичный файл и запишите содержимое

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

Параметры звонка:

  • fname : String, укажите имя файла
  • data : Buffer , указать двоичные данные для записи

appendFile

Создайте двоичный файл и запишите содержимое

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

Параметры звонка:

  • fname : String, укажите имя файла
  • data : Buffer , указать двоичные данные для записи

setZipFS

Установить zip виртуальное сопоставление файлов

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

Параметры звонка:

  • fname : String, указать путь отображения
  • data : Buffer , укажите данные сопоставленного файла zip

clearZipFS

Очистить zip виртуальное сопоставление файлов

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

Параметры звонка:

  • fname : String, указать путь отображения, очистить весь кеш по умолчанию

Статическое свойство

constants

Объект, постоянный объект модуля fs

1
static readonly Object fs.constants;

постоянная

SEEK_SET

постоянный режим поиска, переход в абсолютное положение

1
const fs.SEEK_SET = 0;

SEEK_CUR

постоянный режим поиска, перемещение в относительное положение текущей позиции

1
const fs.SEEK_CUR = 1;

SEEK_END

постоянный режим поиска, перемещение в относительную позицию конца файла

1
const fs.SEEK_END = 2;