Note: This is the migration API reference for FAKE 5. The new (modularized) API documentation can be found here. If the API is already migrated you can check here if exists in a module. More information regarding the migration can be found here

OBSOLETE

Please use Fake.IO.Zip instead and extend it via Pull Request if required

Zip

Operations and tasks for working with zip archives.

Nested types and modules

TypeDescription
ZipCompressionParams
OBSOLETE

Please use Fake.IO.Zip instead and extend it via Pull Request if required

The zip archive compression parameters.

Functions and values

Function or valueDescription
addZipEntry(outStream)
Signature: outStream:ZipOutputStream -> ArchiveFileSpec -> unit
Attributes:
[<Obsolete("Please use Fake.IO.Zip instead and extend it via Pull Request if required")>]
OBSOLETE

Please use Fake.IO.Zip instead and extend it via Pull Request if required

Adds a file, specified by an ArchiveFileSpec, to a ZipOutputStream.
compress(zipParams)
Signature: zipParams:ZipCompressionParams -> FileInfo -> seq<ArchiveFileSpec> -> unit
Attributes:
[<Obsolete("Please use Fake.IO.Zip instead and extend it via Pull Request if required")>]
OBSOLETE

Please use Fake.IO.Zip instead and extend it via Pull Request if required

Constructs a function that will create a zip archive from a set of files.
Compress(...)
Signature: setParams:(ZipCompressionParams -> ZipCompressionParams) -> flatten:bool -> baseDir:DirectoryInfo -> archiveFile:FileInfo -> files:seq<FileInfo> -> unit
Attributes:
[<Obsolete("Please use Fake.IO.Zip instead and extend it via Pull Request if required")>]
OBSOLETE

Please use Fake.IO.Zip instead and extend it via Pull Request if required

Creates a zip archive with the given files.

Parameters

  • setParams - A function which modifies the default compression parameters.
  • flatten - If set to true then all subfolders are merged into the root folder of the archive.
  • baseDir - The relative directory of the files to be compressed. Use this parameter to influence directory structure within the archive.
  • archiveFile - The output archive file. If existing, will be overwritten.
  • files - A sequence of files to compress.
CompressDir(...)
Signature: setParams:(ZipCompressionParams -> ZipCompressionParams) -> flatten:bool -> baseDir:DirectoryInfo -> archiveFile:FileInfo -> unit
Attributes:
[<Obsolete("Please use Fake.IO.Zip instead and extend it via Pull Request if required")>]
OBSOLETE

Please use Fake.IO.Zip instead and extend it via Pull Request if required

Creates a zip archive containing all the files in a directory.

Parameters

  • setParams - A function which modifies the default compression parameters.
  • flatten - If set to true then all subfolders are merged into the root folder of the archive.
  • baseDir - The base directory to be compressed. This directory will be the root of the resulting archive.
  • archiveFile - The output archive file. If existing, will be overwritten.
CompressDirWithDefaults(...)
Signature: baseDir:DirectoryInfo -> archiveFile:FileInfo -> unit
Attributes:
[<Obsolete("Please use Fake.IO.Zip instead and extend it via Pull Request if required")>]
OBSOLETE

Please use Fake.IO.Zip instead and extend it via Pull Request if required

Creates a zip archive containing all the files in a directory.

Parameters

  • baseDir - The base directory to be compressed. This directory will be the root of the resulting archive.
  • archiveFile - The output archive file. If existing, will be overwritten.
CompressSpecs(...)
Signature: setParams:(ZipCompressionParams -> ZipCompressionParams) -> archiveFile:FileInfo -> fileSpecs:seq<ArchiveFileSpec> -> unit
Attributes:
[<Obsolete("Please use Fake.IO.Zip instead and extend it via Pull Request if required")>]
OBSOLETE

Please use Fake.IO.Zip instead and extend it via Pull Request if required

Creates a zip archive with the given archive file specifications.

Parameters

  • setParams - A function which modifies the default compression parameters.
  • archiveFile - The output archive file. If existing, will be overwritten.
  • fileSpecs - A sequence of archive file specifications.
compressStream arg1 inner
Signature: ZipCompressionParams -> inner:Stream -> ZipOutputStream
Attributes:
[<Obsolete("Please use Fake.IO.Zip instead and extend it via Pull Request if required")>]
OBSOLETE

Please use Fake.IO.Zip instead and extend it via Pull Request if required

Wraps an output stream with a zip compressor.
CompressWithDefaults(...)
Signature: baseDir:DirectoryInfo -> archiveFile:FileInfo -> files:seq<FileInfo> -> unit
Attributes:
[<Obsolete("Please use Fake.IO.Zip instead and extend it via Pull Request if required")>]
OBSOLETE

Please use Fake.IO.Zip instead and extend it via Pull Request if required

Creates a zip archive with the given files with default parameters.

Parameters

  • baseDir - The relative directory of the files to be compressed. Use this parameter to influence directory structure within the archive.
  • archiveFile - The output archive file. If existing, will be overwritten.
  • files - A sequence of files to compress.
createFile zipParams file
Signature: zipParams:ZipCompressionParams -> file:FileInfo -> ZipOutputStream
Attributes:
[<Obsolete("Please use Fake.IO.Zip instead and extend it via Pull Request if required")>]
OBSOLETE

Please use Fake.IO.Zip instead and extend it via Pull Request if required

Creates a ZipOutputStream wrapping a file using the given parameters.

Parameters

  • zipParams - The zip compression parameters.
  • file - The FileInfo describing the location to which the archive should be written. Will be overwritten if it exists.
Extract extractDir archiveFile
Signature: extractDir:DirectoryInfo -> archiveFile:FileInfo -> unit
Attributes:
[<Obsolete("Please use Fake.IO.Zip instead and extend it via Pull Request if required")>]
OBSOLETE

Please use Fake.IO.Zip instead and extend it via Pull Request if required

Extracts a zip archive to a given directory.

Parameters

  • extractDir - The directory into which the archived files will be extracted.
  • archiveFile - The archive to be extracted.
extractStream(inner)
Signature: inner:Stream -> ZipInputStream
Attributes:
[<Obsolete("Please use Fake.IO.Zip instead and extend it via Pull Request if required")>]
OBSOLETE

Please use Fake.IO.Zip instead and extend it via Pull Request if required

Wraps an input stream with a zip decompressor.
ZipCompressionDefaults
Signature: ZipCompressionParams
Attributes:
[<Obsolete("Please use Fake.IO.Zip instead and extend it via Pull Request if required")>]
OBSOLETE

Please use Fake.IO.Zip instead and extend it via Pull Request if required

The default zip archive compression parameters

Defaults

  • Level - CompressionLevel.Default
  • Comment - None