Obxecto ZipFile
Os obxectos ZipFile sonzipUn obxecto importante no módulo de compresión e descompresión de ficheiros de formato, que ofrece soporte parazipacceso de lectura e escritura aos ficheiros
Os obxectos ZipFile herdanStreamobxecto, para que poida pasarStreamOs obxectos son operados da mesma maneira.
As funcións estáticas máis usadas son:
- zip.open: abrir azipficheiro ou fluxo
- zip.isZipFile: Determine se o ficheiro ézipdocumento
- fs.setZipFS:montarzipsistema de ficheiros virtual de ficheiros
- fs.clearZipFS: clarozipsistema de ficheiros virtual de ficheiros
As funcións e métodos de instancia de uso habitual do obxecto ZipFile son:
- NArrayZipFile.namelist(): Obter unha lista de nomes de ficheiros
- NONobxectoZipFile.getinfo(Membro da cadea): obtén información do ficheiro
- Buffer ZipFile.read(Membro de cadea, contrasinal de cadea = ""): le o ficheiro especificado
- NArrayZipFile.readAll(String password = ""): le todos os ficheiros
- baleiroZipFile.extract(Membro de cadea, Stringpath, String password = ""): descomprima o ficheiro na ruta especificada
- baleiroZipFile.extract(Membro de cadea,SeekableStreamstrm, String password = ""): descomprime o ficheiro no fluxo
- baleiroZipFile.extractAll(Cordapath, String password = ""): descomprime todos os ficheiros na ruta especificada
- baleiroZipFile.write(String filename, String inZipName, String password = ""): escriba o ficheiro especificado no ficheiro comprimido
- baleiroZipFile.write(Bufferdata, String inZipName, String password = ""): escriba o ficheiro especificado no ficheiro comprimido
- baleiroZipFile.write(SeekableStreamstrm, String inZipName, String password = ""): escriba o ficheiro especificado no ficheiro comprimido
- baleiroZipFile.close(): pechar abertozipdocumento
O exemplo de código é o seguinte:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15var 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();
relación de herdanza
función de membro
namelist
Obter unha lista de nomes de ficheiros
1NArray ZipFile.namelist() async;
devolver resultado:
- NArray, devolve un obxecto de lista que contén nomes de ficheiros
infolist
Obter unha lista de información do ficheiro
1NArray ZipFile.infolist() async;
devolver resultado:
- NArray, devolve un obxecto de lista que contén información do ficheiro
A información do ficheiro contén campos: nome do ficheiro, data, tipo_comprimir, tamaño_comprimir, tamaño_ficheiro, contrasinal, datos
getinfo
Obter información do ficheiro
1NObject ZipFile.getinfo(String member) async;
Parámetros de chamada:
- member: Cadea, especifica o nome do ficheiro para obter información
devolver resultado:
- NObject, devolve o obxecto de información do ficheiro
A información do ficheiro contén campos: nome do ficheiro, data, tipo_comprimir, tamaño_comprimir, tamaño_ficheiro, contrasinal, datos
read
Devolve os datos lidos do ficheiro comprimido
1
2Buffer ZipFile.read(String member,
String password = "") async;
Parámetros de chamada:
- member: Cadea, especifica o nome do ficheiro a ler
- password: String, contrasinal de descompresión, non hai contrasinal por defecto
devolver resultado:
- Buffer, devolve todos os datos do ficheiro
readAll
descomprimir todos os ficheiros
1NArray ZipFile.readAll(String password = "") async;
Parámetros de chamada:
- password: String, contrasinal de descompresión, non hai contrasinal por defecto
devolver resultado:
- NArray, unha lista que contén todos os datos e información do ficheiro
extract
Descomprimir o ficheiro especificado
1
2
3ZipFile.extract(String member,
String path,
String password = "") async;
Parámetros de chamada:
- member: Cadea, especifica o nome do ficheiro que se vai descomprimir
- path: Cadea, especifica o camiño para extraer
- password: String, contrasinal de descompresión, non hai contrasinal por defecto
Descomprime o ficheiro especificado nun fluxo
1
2
3ZipFile.extract(String member,
SeekableStream strm,
String password = "") async;
Parámetros de chamada:
- member: Cadea, especifica o nome do ficheiro que se vai descomprimir
- strm:SeekableStream, especifica o fluxo para descomprimir
- password: String, contrasinal de descompresión, non hai contrasinal por defecto
extractAll
Descomprima todos os ficheiros na ruta especificada
1
2ZipFile.extractAll(String path,
String password = "") async;
Parámetros de chamada:
- path: Cadea, especifica o camiño para extraer
- password: String, contrasinal de descompresión, non hai contrasinal por defecto
write
Escriba o ficheiro especificado no ficheiro comprimido
1
2
3ZipFile.write(String filename,
String inZipName,
String password = "") async;
Parámetros de chamada:
- filename: Cadea, especifica o ficheiro a escribir
- inZipName: Cadena, comprimidazipnome do ficheiro dentro do ficheiro
- password: String, contrasinal de descompresión, non hai contrasinal por defecto
Escriba o ficheiro especificado no ficheiro comprimido
1
2
3ZipFile.write(Buffer data,
String inZipName,
String password = "") async;
Parámetros de chamada:
- data:Buffer, especifica os datos do ficheiro para escribir
- inZipName: Cadena, comprimidazipnome do ficheiro dentro do ficheiro
- password: String, contrasinal de descompresión, non hai contrasinal por defecto
Escriba o ficheiro especificado no ficheiro comprimido
1
2
3ZipFile.write(SeekableStream strm,
String inZipName,
String password = "") async;
Parámetros de chamada:
- strm:SeekableStream, especifica o fluxo de datos para escribir no ficheiro
- inZipName: Cadena, comprimidazipnome do ficheiro dentro do ficheiro
- password: String, contrasinal de descompresión, non hai contrasinal por defecto
close
pechar abertozipdocumento
1ZipFile.close() async;
toString
Devolve a representación en cadea do obxecto, xeralmente devolve "[Obxecto nativo]", o obxecto pódese reimplementar segundo as súas propias características
1String ZipFile.toString();
devolver resultado:
- String, devolve unha representación en cadea do obxecto
toJSON
Devolve a representación en formato JSON do obxecto, xeralmente devolve unha colección de propiedades lexibles definidas polo obxecto
1Value ZipFile.toJSON(String key = "");
Parámetros de chamada:
- key: Cadena, non usada
devolver resultado:
- Value, que devolve un valor serializable por JSON