ОбъектZipFile

Объект ZipFilezipВажный объект в модуле сжатия и распаковки файлов формата, который обеспечиваетzipДоступ для чтения и записи к файлам

Объекты ZipFile наследуются отStreamобъект, поэтому его можно передатьStreamДействуйте так же, как и объекты.

Обычно используемые статические функции:

• zip.open:Открытьzipфайл или поток
• zip.isZipFile: Определить, является ли файлzipдокумент
• fs.setZipFS:настраиватьzipфайловая виртуальная файловая система
• fs.clearZipFS: прозрачныйzipфайловая виртуальная файловая система

Общие функции экземпляра и методы объектов ZipFile:

• НАррайZipFile.namelist(): Получить список имен файлов
• НОбъектZipFile.getinfo(Строковый член): получить информацию о файле.
• Buffer ZipFile.read(строковый член, строковый пароль = ""): прочитать указанный файл.
• НАррайZipFile.readAll(Строковый пароль = ""): прочитать все файлы.
• пустотаZipFile.extract(Строковый член, Строкаpath, String пароль = ""): Извлеките файл по указанному пути.
• пустотаZipFile.extract(строковый член,SeekableStreamstrm, String пароль = ""): Распаковать файл в поток.
• пустотаZipFile.extractAll(Нитьpath, String пароль = ""): Извлеките все файлы по указанному пути.
• пустотаZipFile.write(Строка имя файла, строка inZipName, строка пароль = «»): записать указанный файл в сжатый файл.
• пустотаZipFile.write(Bufferdata, String inZipName, String пароля = ""): Записать указанный файл в сжатый файл.
• пустотаZipFile.write(SeekableStreamstrm, String inZipName, String пароль = ""): Записать указанный файл в сжатый файл.
• пустотаZipFile.close(): закрыть открытьzipдокумент

Пример кода выглядит следующим образом:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
var zip = require('zip');
var path = require('path');
var fs = require('fs');

var zipfile = zip.open(path.join(__dirname, 'unzip_test.zip'), 'w');

// write a file
var buf = new Buffer('test data');
zipfile.write(buf, 'test.txt');

// read a file
buf = zipfile.read("unzip_test.js");
console.log(buf);

zipfile.close();

отношения наследства

функция-член

namelist

Получить список имен файлов

1
NArray ZipFile.namelist() async;

Результаты возврата:

• NArray, возвращает объект списка, содержащий имена файлов

---

infolist

Получить список информации о файле

1
NArray ZipFile.infolist() async;

Результаты возврата:

• NArray, возвращает объект списка, содержащий информацию о файле

Информация о файле включает поля: имя файла, дата, тип_компрессии, размер_сжатия, размер_файла, пароль, данные.

---

getinfo

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

1
NObject ZipFile.getinfo(String member) async;

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

• member: строка, указывает имя файла, из которого нужно получить информацию.

Результаты возврата:

• NObject, возвращает объект информации о файле

Информация о файле включает поля: имя файла, дата, тип_компрессии, размер_сжатия, размер_файла, пароль, данные.

---

read

Возвращает данные, прочитанные из сжатого файла.

1
2
Buffer ZipFile.read(String member,
    String password = "") async;

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

• member: строка, указывает имя файла для чтения.
• password: строка, пароль для распаковки, по умолчанию пароль отсутствует.

Результаты возврата:

• Buffer, возвращает все данные файла

---

readAll

Разархивируйте все файлы

1
NArray ZipFile.readAll(String password = "") async;

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

• password: строка, пароль для распаковки, по умолчанию пароль отсутствует.

Результаты возврата:

• NArray, список, содержащий все данные файла и информацию

---

extract

Разархивируйте указанный файл

1
2
3
ZipFile.extract(String member,
    String path,
    String password = "") async;

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

• member: строка, укажите имя файла, который нужно распаковать.
• path: строка, укажите путь для распаковки.
• password: строка, пароль для распаковки, по умолчанию пароль отсутствует.

---

Распаковать указанный файл в поток

1
2
3
ZipFile.extract(String member,
    SeekableStream strm,
    String password = "") async;

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

• member: строка, укажите имя файла, который нужно распаковать.
• strm:SeekableStream, укажите поток, который нужно распаковать
• password: строка, пароль для распаковки, по умолчанию пароль отсутствует.

---

extractAll

Разархивируйте все файлы по указанному пути

1
2
ZipFile.extractAll(String path,
    String password = "") async;

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

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

---

write

Записать указанный файл в сжатый файл

1
2
3
ZipFile.write(String filename,
    String inZipName,
    String password = "") async;

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

• filename: строка, указывает файл для записи.
• inZipName: строка, сжатаяzipимя файла внутри файла
• password: строка, пароль для распаковки, по умолчанию пароль отсутствует.

---

Записать указанный файл в сжатый файл

1
2
3
ZipFile.write(Buffer data,
    String inZipName,
    String password = "") async;

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

• data:Buffer, укажите данные файла для записи
• inZipName: строка, сжатаяzipимя файла внутри файла
• password: строка, пароль для распаковки, по умолчанию пароль отсутствует.

---

Записать указанный файл в сжатый файл

1
2
3
ZipFile.write(SeekableStream strm,
    String inZipName,
    String password = "") async;

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

• strm:SeekableStream, указывает поток данных файла, в который будет записана
• inZipName: строка, сжатаяzipимя файла внутри файла
• password: строка, пароль для распаковки, по умолчанию пароль отсутствует.

---

close

закрыто открытоzipдокумент

1
ZipFile.close() async;

---

toString

Возвращает строковое представление объекта. Обычно возвращается «[Native Object]». Объект может быть повторно реализован в соответствии с его собственными характеристиками.

1
String ZipFile.toString();

Результаты возврата:

• String, возвращает строковое представление объекта

---

toJSON

Возвращает представление объекта в формате JSON, обычно возвращая коллекцию читаемых свойств, определенных объектом.

1
Value ZipFile.toJSON(String key = "");

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

• key: Строка, не используется.

Результаты возврата:

• Value, возвращает значение, содержащее сериализуемый JSON