A plugin that provides the capability to compress a response and decompress request bodies. You can use different compression algorithms, including gzip and deflate, specify the required conditions for compressing data (such as a content type or response size), or even compress data based on specific request parameters.

Functions

condition

fun ConditionsHolderBuilder.condition(predicate: ApplicationCall.(OutgoingContent) -> Boolean)

Appends a custom condition to the encoder or the Compression configuration. A predicate returns true when a response need to be compressed. If at least one condition is not met, a response isn't compressed.

deflate

fun CompressionConfig.deflate(block: CompressionEncoderBuilder.() -> Unit = {})

Appends the deflate encoder with the block configuration and the 0.9 priority.

excludeContentType

fun ConditionsHolderBuilder.excludeContentType(vararg mimeTypes: ContentType)

Appends a content type exclusion condition to the encoder or the Compression configuration.

gzip

fun CompressionConfig.gzip(block: CompressionEncoderBuilder.() -> Unit = {})

Appends the gzip encoder with the block configuration.

identity

fun CompressionConfig.identity(block: CompressionEncoderBuilder.() -> Unit = {})

Appends the identity encoder with the block configuration.

matchContentType

fun ConditionsHolderBuilder.matchContentType(vararg mimeTypes: ContentType)

Appends a content type condition to the encoder or the Compression configuration.

minimumSize

fun ConditionsHolderBuilder.minimumSize(minSize: Long)

Appends a minimum size condition to the encoder or the Compression configuration.