Class: GzipFile

@nginstack/engine/lib/compress/GzipFile~ GzipFile


new GzipFile(fileName, mode, level)

Classe que permite trabalhar com arquivos Gzip. Objetos desta classe podem ser utilizados da mesma forma que um objeto da classe File.

Parameters:
Name Type Description
fileName string

Nome do arquivo

mode string

Modo como o arquivo deve ser aberto. Seguem abaixo as opções disponíveis:

  • openRead: descomprimir um arquivo
  • openWrite: criar ou adicionar informações para um arquivo comprimido
  • create: criar novo arquivo comprimido
level number

Nível de compressão. Deve ser informado um número de 0 a 9, sendo maior a compressão quanto mais alto for o nível.

Members


BEST_COMPRESSION

Constante indicando que a compressão deve favorecer a compressão do conteúdo em detrimento da velocidade da compactação. É o mesmo que level = 9.


BEST_SPEED

Constante indicando que a compressão deve favorecer a velocidade de compactação em detrimento da compressão do conteúdo. É o mesmo que level = 1.


DEFAULT_COMPRESSION

Constante indicando o nível de compressão padrão. É o mesmo que level = 6.


NO_COMPRESSION

Constante indicando que não deve ocorrer compressão. É o mesmo que level = 0.


position

Posição atual do arquivo descomprimido.


size

Propriedade não suportada

Methods


clear()

Método não suportado em arquivos Gzip.


close()

Fecha o arquivo imediatamente, permitindo que um outro processo possa ler o arquivo sem depender da execução do Garbage Collector do JavaScript.


flush()

Força a atualização física do arquivo, garantindo que os dados não estão bufferizados em memória. Este método é desaconselhado, pois causa perda de performance e diminui a taxa de compressão.


read( [opt_count])

Lê uma string descomprimida do arquivo a partir da posição atual.

Exemplo:

var file = new GzipFile('myCompressedFile.gz') var decompressedContent = file.read()

Parameters:
Name Type Argument Description
opt_count number <optional>

Quantidade de bytes descomprimidos que devem ser lidos. Caso não seja informado, será retornado o conteúdo do arquivo a partir da posição atual.

See:
  • GzipFile.readln
Returns:
Type
string

readln()

Lê uma linha descomprimida do arquivo a partir da posição atual.

Exemplo:

var file = new GzipFile( 'myCompressedFile.gz') var line1 = file.readln() var line2 = file.readln()

See:
  • GzipFile.read

write(content)

Escreve uma string no arquivo comprimido.

var file = new GzipFile('myCompressedFile.gz', 'create') file.write('Texto a ser comprimido')

Parameters:
Name Type Description
content string

Dado que será comprimido.

See:
  • GzipFile.writeln

writeln(content)

Escreve uma string acrescida de um salto de linha ("\r\n") no arquivo comprimido.

var file = new GzipFile('myCompressedFile.gz', 'create') file.writeln('Linha 1') file.writeln('Linha 2')

Parameters:
Name Type Description
content string

Dado que será comprimido.

See:
  • GzipFile.write