Note: This API documentation is for FAKE version 4. The migration API documentation can be found here. The API documentation for the new fake 5 modules can be found here

GZip

Operations and tasks for working with gzip compressed files.

Nested types and modules

Type	Description
GZipCompressionParams	The gzip archive compression parameters.

Functions and values

Function or value	Description
`CompressFile setParams outFile file` Signature: setParams:(GZipCompressionParams -> GZipCompressionParams) -> outFile:FileInfo -> file:FileInfo -> unit	Compresses a file using gzip. Parameters `setParams` - A function which modifies the default compression parameters. `outFile` - The compressed output file. If existing, will be overwritten. `file` - The file to be compressed.
`CompressFileWithDefaults outFile file` Signature: outFile:FileInfo -> file:FileInfo -> unit	Compresses a file using gzip. Parameters `outFile` - The compressed output file. If existing, will be overwritten. `file` - The file to be compressed.
`compressStream arg1 inner` Signature: GZipCompressionParams -> inner:Stream -> GZipOutputStream	Wraps an output stream with a gzip compressor.
`createFile gzipParams file` Signature: gzipParams:GZipCompressionParams -> file:FileInfo -> GZipOutputStream	Creates a `GZipOutputStream` wrapping a file using the given parameters. Parameters `gzipParams` - The gzip compression parameters. `file` - The `FileInfo` describing the location to which the compressed file should be written. Will be overwritten if it exists.
`ExtractFile outFile file` Signature: outFile:FileInfo -> file:FileInfo -> unit	Extracts a file compressed with gzip. Parameters `outFile` - The extracted output file. If existing, will be overwritten. `file` - The compressed file.
`extractStream(inner)` Signature: inner:Stream -> GZipInputStream	Wraps an input stream with a zip decompressor.
`GZipCompressionDefaults` Signature: GZipCompressionParams	The default gzip archive compression parameters Defaults `Level` - `CompressionLevel.Default`