Request Compression Plugin

Compress request bodies on the client and decompress them on the server to reduce bandwidth usage for large payloads.

Client

Use RequestCompressionLinkPlugin to compress request bodies. Configure the compression scheme and size threshold:

import { RequestCompressionLinkPlugin } from '@orpc/client/plugins'

const link = new RPCLink({
  plugins: [
    new RequestCompressionLinkPlugin({
      /**
       * The compression scheme to use for request compression.
       * Supported values: 'gzip' | 'deflate' | 'deflate-raw'
       *
       * @default 'gzip'
       */
      encoding: 'gzip',

      /**
       * The minimum request size in bytes required to trigger compression.
       * Requests smaller than this threshold will not be compressed to avoid overhead.
       * If the request size cannot be determined, compression will still be applied.
       *
       * @default 1024 (1KB)
       */
      threshold: 1024
    }),
  ],
})

Server

Use RequestCompressionHandlerPlugin to decompress request bodies. The plugin automatically detects the client’s compression scheme based on the Content-Encoding header:

import { RequestCompressionHandlerPlugin } from '@orpc/server/plugins'

const handler = new RPCHandler(router, {
  plugins: [
    new RequestCompressionHandlerPlugin(),
  ],
})

Learn More

For implementation details, see the RequestCompressionLinkPlugin source code or the RequestCompressionHandlerPlugin source code.