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

ArchiveHelper

Provides utility tasks for storing and compressing files in archives.

Nested types and modules

TypeDescription
ArchiveFileSpec

A description of a file to be added to an archive.

ExtractEntrySpec
ModuleDescription
BZip2

Operations and tasks for working with gzip compressed files.

CompressionLevel

Provides validation of comression levels used for the zip and gzip compression algorithms.

GZip

Operations and tasks for working with gzip compressed files.

Tar

Operations and tasks for working with tar archives.

Zip

Operations and tasks for working with zip archives.

Functions and values

Function or valueDescription
addEntry(...)
Signature: prepareEntry:(FileInfo -> string -> string) -> afterEntry:('?11731 -> '?11732) -> outStream:'?11731 -> ArchiveFileSpec -> '?11732
Type parameters: '?11731, '?11732
allFilesInDirectory(baseDir)
Signature: baseDir:DirectoryInfo -> seq<FileInfo>
archiveFileSpec(file)
Signature: file:FileInfo -> ArchiveFileSpec

Constructs a file specification which will archive the file at the root.

archiveFileSpecWithBaseDir baseDir file
Signature: baseDir:DirectoryInfo -> file:FileInfo -> ArchiveFileSpec

Constructs a file specification which will archive the file with a path relative to the baseDir.

buildFileSpec flatten baseDir
Signature: flatten:bool -> baseDir:DirectoryInfo -> FileInfo -> ArchiveFileSpec
copyFileBuffered(...)
Signature: bufferSize:int -> outStream:'?11728 -> inStream:'?11729 -> unit
Type parameters: '?11728, '?11729
copyStreamBuffered(...)
Signature: bufferSize:int -> outStream:'?11725 -> inStream:'?11726 -> length:int64 -> unit
Type parameters: '?11725, '?11726
createArchive(...)
Signature: streamCreator:(FileInfo -> '?11740) -> addEntry:('?11740 -> '?11741 -> unit) -> archiveFile:FileInfo -> items:seq<'?11741> -> unit
Type parameters: '?11740, '?11741
createArchiveStream(...)
Signature: streamCreator:(Stream -> '?11736) -> archiveFile:FileInfo -> '?11736
Type parameters: '?11736
DefaultBufferSize
Signature: int
Attributes:
[<Literal>]
doCompression(...)
Signature: compressor:('?11747 -> seq<'?11748> -> '?11749) -> archivePath:'?11747 -> fileSpecGenerator:('?11750 -> '?11748) -> seq<'?11750> -> '?11749
Type parameters: '?11747, '?11748, '?11749, '?11750
extractEntries getNextEntry inStream
Signature: getNextEntry:('?11743 -> ExtractEntrySpec option) -> inStream:'?11743 -> unit
Type parameters: '?11743
extractEntry inStream entry
Signature: inStream:'?11734 -> entry:ExtractEntrySpec -> unit
Type parameters: '?11734
openArchiveStream(...)
Signature: streamCreator:(Stream -> '?11738) -> archiveFile:FileInfo -> '?11738
Type parameters: '?11738