Summary

Functions

API Reference

Functions

DecompressionReadStream:read

DecompressionReadStream:read(size: number?) → string

DecompressionReadStream:readSync

DecompressionReadStream:readSync(size: number?) → string

DecompressionReadStream:readBuffer

DecompressionReadStream:readBuffer(size: number?) → buffer

DecompressionReadStream:readBufferSync

DecompressionReadStream:readBufferSync(size: number?) → buffer

DecompressionReadStream:close

DecompressionReadStream:close() → ()

DecompressionReadStream:closeSync

DecompressionReadStream:closeSync() → ()

CompressionWriteStream:write

CompressionWriteStream:write(data: string | buffer) → number

CompressionWriteStream:writeSync

CompressionWriteStream:writeSync(data: string | buffer) → number

CompressionWriteStream:flush

CompressionWriteStream:flush() → ()

CompressionWriteStream:flushSync

CompressionWriteStream:flushSync() → ()

CompressionWriteStream:close

CompressionWriteStream:close() → ()

CompressionWriteStream:closeSync

CompressionWriteStream:closeSync() → ()

compressionStream.wrap

compressionStream.wrap(source: streamTypes.StreamThatCanRead, decompressor: Decompressor, options: WrapOptions?) → ReadStream

compressionStream.wrapWriter

compressionStream.wrapWriter(sink: streamTypes.StreamThatCanWrite, compressor: Compressor, options: WrapWriterOptions?) → WriteStream

Types

Decompressor

type Decompressor = { write: ((self: any, data: buffer) → (buffer, boolean)), close: ((self: any) → ()) }

Decompressor:write(data: buffer) → (buffer, boolean)

Decompressor:close() → ()

Compressor

type Compressor = { write: ((self: any, data: buffer, flush: number?) → buffer), finish: ((self: any) → buffer), close: ((self: any) → ()), flush: (((self: any) → buffer))? }

Compressor:write(data: buffer, flush: number?) → buffer

Compressor:finish() → buffer

Compressor:close() → ()

flush: (((self: any) → buffer))?

WrapOptions

type WrapOptions = { chunkSize: number?, closeSource: boolean? }

chunkSize: number?

closeSource: boolean?

WrapWriterOptions

type WrapWriterOptions = { closeSink: boolean? }

closeSink: boolean?

ReadStream

type ReadStream = streamTypes.ReadOnlyStream

Implements: streamTypes.ReadOnlyStream

WriteStream

type WriteStream = streamTypes.WriteOnlyStream & streamTypes.StreamThatCanFlush

Implements: streamTypes.WriteOnlyStream, streamTypes.StreamThatCanFlush