Kitura compression middleware
Kitura compression middleware for compressing body data sent back to the client. Supports
gzip compression methods. Uses zlib.
Table of Contents
The latest version of Kitura-Compression requires Swift 4.0 or newer. You can download this version of the Swift binaries by following this link. Compatibility with other Swift versions is not guaranteed.
In order to use compression middleware, create an instance of
Compression, and connect it to the desired path:
import KituraCompression router.all(middleware: Compression())
You can configure
Compression with optional arguments:
public init (threshold: Int = 1024, chunkSize: Int = 16384, compressionLevel: CompressionLevel = CompressionLevel.defaultCompression, compressionStrategy: CompressionStrategy = CompressionStrategy.defaultStrategy, memoryLevel: Int32 = 8)
threshold is the byte threshold for the response body size before compression is considered for the response, defaults to 1024.
chunkSize is the size of internal output slab buffer in bytes, defaults to 16384
compressionLevel is the level of zlib compression to apply. The supported values are:
.noCompression, .bestSpeed, .bestCompression, .defaultCompression
compressionStrategy is used to tune the compression algorithm. Here are its possible values:
.defaultStrategy, .filtered, .huffmanOnly, .rle, .fixed
memoryLevel specifies how much memory should be allocated for the internal compression state. The default value is 8.
For more information on compression parameters, see zlib manual.
This library is licensed under Apache 2.0. Full license text is available in LICENSE.
Help us keep the lights on
2.1.0 - Jan 10, 2018
- Update dependencies to Kitura 2.1.x
2.0.0 - Oct 31, 2017
- Full migration to Swift 4
1.7.1 - Sep 15, 2017
- Add support for Swift 4