nginstack

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: escrever informações em um arquivo comprimido. Abrir com este modo trunca o tamanho do arquivo para zero.
  • create: criar novo arquivo comprimido.

Caso um arquivo seja aberto com a opção openRead e não esteja compactado, o Gzip lerá como arquivo padrão.

O Gzip não suporta a opção openReadWrite, que permitiria adicionar ao conteúdo já existente.
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

<static> 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.

<static> 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.

<static> DEFAULT_COMPRESSION

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

<static> NO_COMPRESSION

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

eof :boolean

Indica se o final do arquivo foi atingido.

Type:
  • boolean

position :number

Posição atual do arquivo descomprimido.

Type:
  • number

size :number

Propriedade não suportada.

Type:
  • number

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 no buffer em memória. Este método é desaconselhado, pois causa perda de performance e diminui a taxa de compressão.

read( [size])

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

Parameters:
Name Type Argument Description
size 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
Example
var file = new GzipFile('myCompressedFile.gz')
var decompressedContent = file.read()

readln()

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

See:
  • GzipFile.read
Returns:
Type
string
Example
var file = new GzipFile( 'myCompressedFile.gz')
var line1 = file.readln()
var line2 = file.readln()

write(content)

Escreve uma string no arquivo comprimido.

Parameters:
Name Type Description
content string

Dado que será comprimido.
See:
  • GzipFile.writeln
Example
var file = new GzipFile('myCompressedFile.gz', 'create')
file.write('Texto a ser comprimido')

writeln(content)

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

Parameters:
Name Type Description
content string

Dado que será comprimido.
See:
  • GzipFile.write
Example
var file = new GzipFile('myCompressedFile.gz', 'create')
file.writeln('Linha 1')
file.writeln('Linha 2')