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

Модуль ФС

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

Инструкции:

1
var fs = require('fs');

Некоторые заметки:

  • Запуск fs.watch(filename) вернет наблюдателя, унаследованного от EventEmitter , который поддерживает три события: «change», «changeonly» и «renameonly»
  • fs.watchFile(target) и fs.unwatchFile(target) прежнему могут использоваться в парах
  • fs.watchFile(target) вернет объект StatsWatcher унаследованный от EventEmitter , вызов fs.unwatchFile(target) эквивалентен вызову StatsWatcher.close() .

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

exists

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

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

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

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

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

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

access

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

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

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

  • path : String, укажите путь для запроса
  • 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 : Integer, укажите установленные права доступа

lchmod

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

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

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

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

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, укажите файл софт-соединения для чтения

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

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

realpath

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

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

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

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

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

  • 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 : String, укажите каталог для запроса

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

  • 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 : строка, указать метод декодирования, по умолчанию не декодировать

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

  • 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, указать путь отображения, очистить все кэши по умолчанию

watch

Наблюдайте за файлом и возвращайте соответствующий объект-наблюдатель

1
static FSWatcher fs.watch(String fname);

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

  • fname : String, указать объект файла для наблюдения

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


Наблюдайте за файлом и возвращайте соответствующий объект-наблюдатель

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

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

  • fname : String, указать объект файла для наблюдения
  • callback : функция, (evtType: 'change' | 'rename', filename: string) => any обратный вызов обработки при изменении объекта файла

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


Наблюдайте за файлом и возвращайте соответствующий объект-наблюдатель

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

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

  • fname : String, указать объект файла для наблюдения
  • options : объект, параметры наблюдения
  • options.persistent : {boolean} default: true, если процесс не завершится, пока целевой файл все еще наблюдается
  • options.recursive : {boolean} default: false Для случая, когда fname является папкой, рекурсивно ли наблюдать все подкаталоги под ней
  • options.encoding : {enum} default: 'utf8' определяет кодировку символов для анализа входящего имени

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


Наблюдайте за файлом и возвращайте соответствующий объект-наблюдатель

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

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

  • fname : String, указать объект файла для наблюдения
  • options : объект, параметры наблюдения
  • options.persistent : {boolean} default: true, если процесс не завершится, пока целевой файл все еще наблюдается
  • options.recursive : {boolean} default: false Для случая, когда fname является папкой, рекурсивно ли наблюдать все подкаталоги под ней
  • options.encoding : {enum} default: 'utf8' определяет кодировку символов для анализа входящего имени
  • callback : (evtType: 'change' | 'rename', filename: string) => any обратный вызов обработки при изменении объекта файла

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


watchFile

Наблюдайте за файлом и возвращайте соответствующий объект StatsWatcher

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

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

  • fname : String, указать объект файла для наблюдения
  • callback : функция, (curStats: Stats, prevStats: Stats) => any обратный вызов обработки при изменении статистики объекта файла

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


Наблюдайте за файлом и возвращайте соответствующий объект StatsWatcher

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

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

  • fname : String, указать объект файла для наблюдения
  • options : объект, параметры наблюдения
  • options.persistent : {boolean} default: true, если процесс не завершится, пока целевой файл все еще наблюдается
  • options.recursive : {boolean} default: false Для случая, когда fname является папкой, рекурсивно ли наблюдать все подкаталоги под ней
  • options.encoding : {enum} default: 'utf8' определяет кодировку символов для анализа входящего имени
  • callback : (curStats: Stats, prevStats: Stats) => any обратный вызов обработки при изменении статистики объекта файла

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


unwatchFile

Удалите обратные вызовы всех событий наблюдения из StatsWatcher который наблюдает за fname

1
static fs.unwatchFile(String fname);

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

  • fname : String, указать объект файла для наблюдения

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


Удалить callback вызов из callback вызова наблюдения StatsWatcher который наблюдает за fname

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

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

  • fname : String, указать объект файла для наблюдения
  • callback : функция, callback должен быть удален

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

Даже если обратного вызова больше нет в StatsWatcher события наблюдения StatsWatcher , об ошибке не сообщается

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

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;