Файловая система

Изменяет права доступа к файлу или каталогу по указанному пути. Игнорирует umask процесса.

await Deno.chmod("/path/to/file", 0o666);

Режим представляет собой последовательность из 3 восьмеричных чисел. Первое (крайнее левое) число задаёт права владельца. Второе число задаёт права группы. Последнее (крайнее правое) число задаёт права остальных пользователей. Например, при режиме 0o764 владелец (7) может читать, записывать и выполнять, группа (6) может читать и записывать, а все остальные (4) могут только читать.

Примечание: в Windows можно изменять только права на чтение и запись. Разграничение прав владельца, группы и остальных пользователей не поддерживается.

Требуется разрешение allow-write.

Синхронно изменяет права доступа к файлу или каталогу по указанному пути. Игнорирует umask процесса.

Deno.chmodSync("/path/to/file", 0o666);

Полное описание см. в разделе Deno.chmod.

Требуется разрешение allow-write.

Изменяет владельца обычного файла или каталога.

Эта функция недоступна в Windows.

await Deno.chown("myFile.txt", 1000, 1002);

Требуется разрешение allow-write.

При выполнении в Windows выдаёт ошибку (функция не реализована).

Синхронно изменяет владельца обычного файла или каталога.

Эта функция недоступна в Windows.

Deno.chownSync("myFile.txt", 1000, 1002);

Требуется разрешение allow-write.

При выполнении в Windows выдаёт ошибку (функция не реализована).

Копирует содержимое и права доступа одного файла в другой по указанному пути. По умолчанию при необходимости создаёт новый файл, иначе перезаписывает существующий. Операция завершается ошибкой, если целевой путь указывает на каталог или файл недоступен для записи.

await Deno.copyFile("from.txt", "to.txt");

Для fromPath требуется разрешение allow-read.

Для toPath требуется разрешение allow-write.

Синхронно копирует содержимое и права доступа одного файла в другой по указанному пути. По умолчанию при необходимости создаёт новый файл, иначе перезаписывает существующий. Операция завершается ошибкой, если целевой путь указывает на каталог или файл недоступен для записи.

Deno.copyFileSync("from.txt", "to.txt");

Для fromPath требуется разрешение allow-read.

Для toPath требуется разрешение allow-write.

Создает файл, если он не существует, или очищает существующий файл и возвращает экземпляр Deno.FsFile.

const file = await Deno.create("/foo/bar.txt");

Требуются разрешения allow-read и allow-write.

Создает файл, если он не существует, или очищает существующий файл и возвращает экземпляр Deno.FsFile.

const file = Deno.createSync("/foo/bar.txt");

Требуются разрешения allow-read и allow-write.

Создает newpath как жесткую ссылку на oldpath.

await Deno.link("old/name", "new/name");

Требуются разрешения allow-read и allow-write.

Синхронно создает newpath как жесткую ссылку на oldpath.

Deno.linkSync("old/name", "new/name");

Требуются разрешения allow-read и allow-write.

Возвращает Deno.FileInfo для указанного path. Если path является символической ссылкой, возвращается информация о самой ссылке, а не об объекте, на который она указывает.

import { assert } from "jsr:@std/assert";
const fileInfo = await Deno.lstat("hello.txt");
assert(fileInfo.isFile);

Требуется разрешение allow-read.

Синхронно возвращает Deno.FileInfo для указанного path. Если path является символической ссылкой, возвращается информация о самой ссылке, а не об объекте, на который она указывает.

import { assert } from "jsr:@std/assert";
const fileInfo = Deno.lstatSync("hello.txt");
assert(fileInfo.isFile);

Требуется разрешение allow-read.

Создает новый временный каталог в каталоге, используемом по умолчанию для временных файлов, если не указан dir. Также можно задать префикс и суффикс имени каталога с помощью prefix и suffix соответственно.

Вызов возвращает полный путь к созданному каталогу.

Одновременный вызов этой функции несколькими программами приведет к созданию разных каталогов. Вызывающая сторона должна удалить каталог, когда он больше не нужен.

const tempDirName0 = await Deno.makeTempDir();  // e.g. /tmp/2894ea76
const tempDirName1 = await Deno.makeTempDir({ prefix: 'my_temp' }); // e.g. /tmp/my_temp339c944d

Требуется разрешение allow-write.

Синхронно создает новый временный каталог в каталоге, используемом по умолчанию для временных файлов, если не указан dir. Также можно задать префикс и суффикс имени каталога с помощью prefix и suffix соответственно.

Возвращается полный путь к созданному каталогу.

Одновременный вызов этой функции несколькими программами приведет к созданию разных каталогов. Вызывающая сторона должна удалить каталог, когда он больше не нужен.

const tempDirName0 = Deno.makeTempDirSync();  // e.g. /tmp/2894ea76
const tempDirName1 = Deno.makeTempDirSync({ prefix: 'my_temp' });  // e.g. /tmp/my_temp339c944d

Требуется разрешение allow-write.

Создает новый временный файл в каталоге, используемом по умолчанию для временных файлов, если не указан dir.

Также можно задать префикс и суффикс имени каталога с помощью prefix и suffix соответственно.

Вызов возвращает полный путь к созданному файлу.

Одновременный вызов этой функции несколькими программами приведет к созданию разных файлов. Вызывающая сторона должна удалить файл, когда он больше не нужен.

const tmpFileName0 = await Deno.makeTempFile();  // e.g. /tmp/419e0bf2
const tmpFileName1 = await Deno.makeTempFile({ prefix: 'my_temp' });  // e.g. /tmp/my_temp754d3098

Требуется разрешение allow-write.

Синхронно создает новый временный файл в каталоге, используемом по умолчанию для временных файлов, если не указан dir.

Также можно задать префикс и суффикс имени каталога с помощью prefix и suffix соответственно.

Возвращается полный путь к созданному файлу.

Одновременный вызов этой функции несколькими программами приведет к созданию разных файлов. Вызывающая сторона должна удалить файл, когда он больше не нужен.

const tempFileName0 = Deno.makeTempFileSync(); // e.g. /tmp/419e0bf2
const tempFileName1 = Deno.makeTempFileSync({ prefix: 'my_temp' });  // e.g. /tmp/my_temp754d3098

Требуется разрешение allow-write.

Создает каталог по указанному пути.

await Deno.mkdir("new_dir");
await Deno.mkdir("nested/directories", { recursive: true });
await Deno.mkdir("restricted_access_dir", { mode: 0o700 });

Выбрасывает исключение, если каталог уже существует, если только для recursive не задано значение true.

Требуется разрешение allow-write.

Синхронно создает каталог по указанному пути.

Deno.mkdirSync("new_dir");
Deno.mkdirSync("nested/directories", { recursive: true });
Deno.mkdirSync("restricted_access_dir", { mode: 0o700 });

Выбрасывает исключение, если каталог уже существует, если только для recursive не задано значение true.

Требуется разрешение allow-write.

Открывает файл и возвращает экземпляр Deno.FsFile. Файл может не существовать до вызова, если используются параметры открытия create или createNew. Чтобы среда выполнения автоматически закрыла файл, когда он выйдет из области видимости, вызывающая сторона может объявить переменную файла с ключевым словом using.

using file = await Deno.open("/foo/bar.txt", { read: true, write: true });
// Do work with file

Кроме того, вызывающая сторона может вручную закрыть ресурс после завершения работы с ним.

const file = await Deno.open("/foo/bar.txt", { read: true, write: true });
// Do work with file
file.close();

В зависимости от параметров требуются разрешения allow-read и/или allow-write.

Синхронно открывает файл и возвращает экземпляр Deno.FsFile. Файл может не существовать до вызова, если используются параметры открытия create или createNew. Чтобы среда выполнения автоматически закрыла файл, когда он выйдет из области видимости, вызывающая сторона может объявить переменную файла с ключевым словом using.

using file = Deno.openSync("/foo/bar.txt", { read: true, write: true });
// Do work with file

Кроме того, вызывающая сторона может вручную закрыть ресурс после завершения работы с ним.

const file = Deno.openSync("/foo/bar.txt", { read: true, write: true });
// Do work with file
file.close();

В зависимости от параметров требуются разрешения allow-read и/или allow-write.

Читает каталог, указанный в path, и возвращает асинхронный итерируемый объект с элементами Deno.DirEntry. Порядок элементов не гарантируется.

for await (const dirEntry of Deno.readDir("/")) {
  console.log(dirEntry.name);
}

Выбрасывает ошибку, если path не является каталогом.

Требуется разрешение allow-read.

Синхронно читает каталог, заданный path, и возвращает итерируемый объект с элементами Deno.DirEntry. Порядок элементов не гарантируется.

for (const dirEntry of Deno.readDirSync("/")) {
  console.log(dirEntry.name);
}

Выбрасывает ошибку, если path не является каталогом.

Требуется разрешение allow-read.

Читает весь файл и возвращает промис, который разрешается массивом байтов. При необходимости для преобразования байтов в строку можно использовать TextDecoder. При чтении каталога промис отклоняется с ошибкой.

const decoder = new TextDecoder("utf-8");
const data = await Deno.readFile("hello.txt");
console.log(decoder.decode(data));

Требуется разрешение allow-read.

Синхронно читает и возвращает всё содержимое файла в виде массива байтов. При необходимости для преобразования байтов в строку можно использовать TextDecoder. При чтении каталога выбрасывается ошибка.

const decoder = new TextDecoder("utf-8");
const data = Deno.readFileSync("hello.txt");
console.log(decoder.decode(data));

Требуется разрешение allow-read.

Возвращает полный путь назначения указанной символической ссылки.

await Deno.symlink("./test.txt", "./test_link.txt");
const target = await Deno.readLink("./test_link.txt"); // full path of ./test.txt

Выбрасывает TypeError при вызове с жёсткой ссылкой.

Требуется разрешение allow-read.

Синхронно возвращает полный путь назначения указанной символической ссылки.

Deno.symlinkSync("./test.txt", "./test_link.txt");
const target = Deno.readLinkSync("./test_link.txt"); // full path of ./test.txt

Выбрасывает TypeError при вызове с жёсткой ссылкой.

Требуется разрешение allow-read.

Асинхронно читает и возвращает всё содержимое файла в виде строки, декодированной из UTF-8.

const data = await Deno.readTextFile("hello.txt");
console.log(data);

Возвращённый промис отклоняется, если операция завершается ошибкой, например с Deno.errors.NotFound, если файл не существует, с Deno.errors.IsADirectory, если path указывает на каталог, или с Deno.errors.PermissionDenied, если необходимое разрешение не было предоставлено.

Требуется разрешение allow-read.

Синхронно читает и возвращает всё содержимое файла в виде строки, декодированной из UTF-8.

const data = Deno.readTextFileSync("hello.txt");
console.log(data);

Выбрасывает ошибку, если операция завершается неудачей, например с Deno.errors.NotFound, если файл не существует, с Deno.errors.IsADirectory, если path указывает на каталог, или с Deno.errors.PermissionDenied, если необходимое разрешение не было предоставлено.

Требуется разрешение allow-read.

Возвращает абсолютный нормализованный путь с разрешёнными символическими ссылками.

// e.g. given /home/alice/file.txt and current directory /home/alice
await Deno.symlink("file.txt", "symlink_file.txt");
const realPath = await Deno.realPath("./file.txt");
const realSymLinkPath = await Deno.realPath("./symlink_file.txt");
console.log(realPath);  // outputs "/home/alice/file.txt"
console.log(realSymLinkPath);  // outputs "/home/alice/file.txt"

Для целевого пути требуется разрешение allow-read.

Если целевой путь относительный, для CWD также требуется разрешение allow-read.

Синхронно возвращает абсолютный нормализованный путь с разрешёнными символическими ссылками.

// e.g. given /home/alice/file.txt and current directory /home/alice
Deno.symlinkSync("file.txt", "symlink_file.txt");
const realPath = Deno.realPathSync("./file.txt");
const realSymLinkPath = Deno.realPathSync("./symlink_file.txt");
console.log(realPath);  // outputs "/home/alice/file.txt"
console.log(realSymLinkPath);  // outputs "/home/alice/file.txt"

Для целевого пути требуется разрешение allow-read.

Если целевой путь относительный, для CWD также требуется разрешение allow-read.

Удаляет указанный файл или каталог.

await Deno.remove("/path/to/empty_dir/or/file");
await Deno.remove("/path/to/populated_dir/or/file", { recursive: true });

Выбрасывает ошибку, если доступ запрещён, путь не найден либо путь указывает на непустой каталог, а параметр recursive не установлен в true.

Требуется разрешение allow-write.

Синхронно удаляет указанный файл или каталог.

Deno.removeSync("/path/to/empty_dir/or/file");
Deno.removeSync("/path/to/populated_dir/or/file", { recursive: true });

Выбрасывает ошибку, если доступ запрещён, путь не найден либо путь указывает на непустой каталог, а параметр recursive не установлен в true.

Требуется разрешение allow-write.

Переименовывает (перемещает) oldpath в newpath. Пути могут указывать на файлы или каталоги. Если newpath уже существует и не является каталогом, rename() заменяет его. Если oldpath и newpath находятся в разных каталогах, могут применяться ограничения, зависящие от ОС.

await Deno.rename("old/path", "new/path");

В Unix-подобных ОС эта операция не следует по символическим ссылкам ни по одному из путей.

Условия, при которых операция выбрасывает ошибки, и сами эти ошибки различаются в зависимости от платформы. Переименование чего-либо в непустой каталог всегда приводит к ошибке.

Требуются разрешения allow-read и allow-write.

Синхронно переименовывает (перемещает) oldpath в newpath. Пути могут указывать на файлы или каталоги. Если newpath уже существует и не является каталогом, renameSync() заменяет его. Если oldpath и newpath находятся в разных каталогах, могут применяться ограничения, зависящие от ОС.

Deno.renameSync("old/path", "new/path");

В Unix-подобных ОС эта операция не следует по символическим ссылкам ни по одному из путей.

Условия, при которых операция выбрасывает ошибки, и сами эти ошибки различаются в зависимости от платформы. Переименование чего-либо в непустой каталог всегда приводит к ошибке.

Требуются разрешения allow-read и allow-write.

Возвращает Deno.FileInfo для указанного path. Всегда следует по символическим ссылкам.

import { assert } from "jsr:@std/assert";
const fileInfo = await Deno.stat("hello.txt");
assert(fileInfo.isFile);

Требуется разрешение allow-read.

Синхронно возвращает Deno.FileInfo для указанного path. Всегда следует по символическим ссылкам.

import { assert } from "jsr:@std/assert";
const fileInfo = Deno.statSync("hello.txt");
assert(fileInfo.isFile);

Требуется разрешение allow-read.

Создаёт newpath как символическую ссылку на oldpath.

Параметру options.type можно присвоить значение "file", "dir" или "junction". Этот аргумент доступен только в Windows и игнорируется на других платформах.

await Deno.symlink("old/name", "new/name");

Требуются разрешения allow-read и allow-write, предоставленные без ограничения области действия путём (т. е. --allow-read --allow-write, а не --allow-read=./dir --allow-write=./dir). Цель символической ссылки может быть относительным, абсолютным или ещё не существующим путём, который разрешается только при последующем переходе по ссылке, поэтому во время её создания проверить этот путь по списку разрешённых путей с ограниченной областью действия невозможно. Поэтому разрешения с ограниченной областью действия пути отклоняются.

Создаёт newpath как символическую ссылку на oldpath.

Параметру options.type можно присвоить значение "file", "dir" или "junction". Этот аргумент доступен только в Windows и игнорируется на других платформах.

Deno.symlinkSync("old/name", "new/name");

Требуются разрешения allow-read и allow-write, предоставленные без ограничения области действия путём (т. е. --allow-read --allow-write, а не --allow-read=./dir --allow-write=./dir). Цель символической ссылки может быть относительным, абсолютным или ещё не существующим путём, который разрешается только при последующем переходе по ссылке, поэтому во время её создания проверить этот путь по списку разрешённых путей с ограниченной областью действия невозможно. Поэтому разрешения с ограниченной областью действия пути отклоняются.

Усекает (или увеличивает) указанный файл до заданного len. Если len не указано, усекается всё содержимое файла.

Усечение всего файла

await Deno.truncate("my_file.txt");

Усечение части файла

const file = await Deno.makeTempFile();
await Deno.writeTextFile(file, "Hello World");
await Deno.truncate(file, 7);
const data = await Deno.readFile(file);
console.log(new TextDecoder().decode(data));  // "Hello W"

Требуется разрешение allow-write.

Синхронно усекает (или увеличивает) указанный файл до заданного len. Если len не указано, усекается всё содержимое файла.

Усечение всего файла

Deno.truncateSync("my_file.txt");

Усечение части файла

const file = Deno.makeTempFileSync();
Deno.writeFileSync(file, new TextEncoder().encode("Hello World"));
Deno.truncateSync(file, 7);
const data = Deno.readFileSync(file);
console.log(new TextDecoder().decode(data));

Требуется разрешение allow-write.

Возвращает маску создания файлов процесса (umask). Если указано mask, задаёт маску создания файлов процесса. Этот вызов всегда возвращает значение маски, действовавшее до вызова.

console.log(Deno.umask());  // e.g. 18 (0o022)
const prevUmaskValue = Deno.umask(0o077);  // e.g. 18 (0o022)
console.log(Deno.umask());  // e.g. 63 (0o077)

Требуется разрешение allow-sys="umask".

Примечание: этот API не реализован в Windows

Изменяет время доступа (atime) и время модификации (mtime) объекта файловой системы, на который ссылается path. Время задаётся либо в секундах (время эпохи UNIX), либо в виде объектов Date.

await Deno.utime("myfile.txt", 1556495550, new Date());

Требуется разрешение allow-write.

Синхронно изменяет время доступа (atime) и время модификации (mtime) объекта файловой системы, на который ссылается path. Время задаётся либо в секундах (время эпохи UNIX), либо в виде объектов Date.

Deno.utimeSync("myfile.txt", 1556495550, new Date());

Требуется разрешение allow-write.

Отслеживает события файловой системы для одного или нескольких paths, которыми могут быть файлы или каталоги. Эти пути уже должны существовать. Одно действие пользователя (например, touch test.file) может вызвать несколько событий файловой системы. Аналогично, одно действие пользователя может привести к появлению нескольких путей к файлам в одном событии (например, mv old_name.txt new_name.txt).

Параметр рекурсивного отслеживания по умолчанию равен true; для каталогов будут отслеживаться указанный каталог и все его подкаталоги.

Обратите внимание, что точный порядок событий может различаться в разных операционных системах.

const watcher = Deno.watchFs("/");
for await (const event of watcher) {
   console.log(">>>> event", event);
   // { kind: "create", paths: [ "/foo.txt" ] }
}

Параметр ignore можно использовать для фильтрации событий по одному или нескольким путям. Путь считается совпавшим, если он сам является игнорируемым путём или находится внутри него, поэтому игнорирование каталога распространяется на всё его содержимое. Относительные пути разрешаются относительно текущего рабочего каталога. Для игнорируемых путей по-прежнему требуется разрешение allow-read, как и для отслеживаемых путей.

// Watch the project but skip the `.git` directory and `build` output.
const watcher = Deno.watchFs(".", { ignore: [".git", "build"] });

Вызовите watcher.close(), чтобы прекратить отслеживание.

const watcher = Deno.watchFs("/");

setTimeout(() => {
  watcher.close();
}, 5000);

for await (const event of watcher) {
   console.log(">>>> event", event);
}

Требуется разрешение allow-read.

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

const encoder = new TextEncoder();
const data = encoder.encode("Hello world\n");
await Deno.writeFile("hello1.txt", data);  // overwrite "hello1.txt" or create it
await Deno.writeFile("hello2.txt", data, { create: false });  // only works if "hello2.txt" exists
await Deno.writeFile("hello3.txt", data, { mode: 0o777 });  // set permissions on new file
await Deno.writeFile("hello4.txt", data, { append: true });  // add data to the end of the file

Требуется разрешение allow-write, а также allow-read, если options.create имеет значение false.

Синхронно записывает data в указанный path, по умолчанию создавая новый файл, если это необходимо, или перезаписывая существующий.

const encoder = new TextEncoder();
const data = encoder.encode("Hello world\n");
Deno.writeFileSync("hello1.txt", data);  // overwrite "hello1.txt" or create it
Deno.writeFileSync("hello2.txt", data, { create: false });  // only works if "hello2.txt" exists
Deno.writeFileSync("hello3.txt", data, { mode: 0o777 });  // set permissions on new file
Deno.writeFileSync("hello4.txt", data, { append: true });  // add data to the end of the file

Требуется разрешение allow-write, а также allow-read, если options.create имеет значение false.

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

await Deno.writeTextFile("hello1.txt", "Hello world\n");  // overwrite "hello1.txt" or create it

Данные записываются в файл, после чего файл закрывается, однако это не гарантирует, что содержимое будет сброшено из буферов операционной системы на физическое устройство хранения. Если требуется такая гарантия сохранности данных (например, перед отправкой сигнала о завершении записи), откройте файл с помощью Deno.open и вызовите Deno.FsFile.sync перед его закрытием.

Требуется разрешение allow-write, а также allow-read, если options.create имеет значение false.

Синхронно записывает строку data в указанный path, по умолчанию создавая новый файл, если это необходимо, или перезаписывая существующий.

Deno.writeTextFileSync("hello1.txt", "Hello world\n");  // overwrite "hello1.txt" or create it

Как и в случае с Deno.writeTextFile, данные записываются, а файл закрывается, однако это не гарантирует, что содержимое будет сброшено из буферов операционной системы на физическое устройство хранения. Если требуется такая гарантия сохранности данных, откройте файл с помощью Deno.openSync и вызовите Deno.FsFile.syncSync перед его закрытием.

Требуется разрешение allow-write, а также allow-read, если options.create имеет значение false.