diff --git a/x-pack/plugins/aiops/server/lib/accept_compression.ts b/x-pack/plugins/aiops/server/lib/accept_compression.ts index b5d1a24060361f..0fd092d6473149 100644 --- a/x-pack/plugins/aiops/server/lib/accept_compression.ts +++ b/x-pack/plugins/aiops/server/lib/accept_compression.ts @@ -7,6 +7,12 @@ import type { Headers } from '@kbn/core/server'; +/** + * Returns whether request headers accept a response using gzip compression. + * + * @param headers - Request headers. + * @returns boolean + */ export function acceptCompression(headers: Headers) { let compressed = false; diff --git a/x-pack/plugins/aiops/server/lib/stream_factory.ts b/x-pack/plugins/aiops/server/lib/stream_factory.ts index fbad49621acb1d..dc67a549025273 100644 --- a/x-pack/plugins/aiops/server/lib/stream_factory.ts +++ b/x-pack/plugins/aiops/server/lib/stream_factory.ts @@ -22,6 +22,14 @@ class ResponseStream extends Stream.PassThrough { const DELIMITER = '\n'; +/** + * Sets up a response stream with support for gzip compression depending on provided + * request headers. + * + * @param logger - Kibana provided logger. + * @param headers - Request headers. + * @returns An object with stream attributes and methods. + */ export function streamFactory(logger: Logger, headers: Headers) { const isCompressed = acceptCompression(headers);